| Packages | |
|---|---|
| Global GI static methods and constants. | |
| The General Interface Asynchronous Modular Platform (AMP). | |
| The standard library of AMP application utility classes. | |
| Application layer classes. | |
| Various Charting related constants and utility functions. | |
| GUI classes. | |
| Utility methods related to rendering HTML. | |
| The public API of the General Interface IDE. | |
| Base classes and the GI introspection framework. | |
| Networking related classes. | |
| Utility classes. | |
| This package and all contained classes are available only when the Charting add-in is enabled. | |
| XML related classes. | |
| Top-Level properties and functions. | |
| Class Summary | |
|---|---|
| jsx3.$Array | Useful extensions to the JavaScript Array class. |
| jsx3.$AsyncCB | The callback object passed as the single argument to an asynchronous method. |
| jsx3.$AsyncRV | The return value from an asynchronous method. |
| jsx3.$Function | Useful extensions to the JavaScript Function class. |
| jsx3.$Hash | Useful extensions to the JavaScript Object class for emulating a hashtable. |
| jsx3.$Object | Useful extensions to the JavaScript Object class. |
| jsx3.$String | Useful extensions to the JavaScript String class. |
| jsx3.Alerts | Deprecated. Renamed to jsx3.gui.Alerts. |
| jsx3.Block | Deprecated. Renamed to jsx3.gui.Block |
| jsx3.BlockX | Deprecated. Renamed to jsx3.gui.BlockX. Most functionality of this class was moved into a new interface,
jsx3.xml.Cacheable. |
| jsx3.Boolean | Boolean class encapsulates GI's XML boolean values (0 and 1 rather than true and false). |
| jsx3.Button | Deprecated. Renamed to jsx3.gui.Button |
| jsx3.CDF | Deprecated. Renamed to jsx3.xml.CDF |
| jsx3.Cache | Deprecated. Renamed to jsx3.app.Cache |
| jsx3.CheckBox | Deprecated. Renamed to jsx3.gui.CheckBox |
| jsx3.Collection | Deprecated. Subsumed by jsx3.util.List. |
| jsx3.Column | Deprecated. Renamed to jsx3.gui.Column |
| jsx3.DOM | Deprecated. Renamed to jsx3.app.DOM |
| jsx3.DatePicker | Deprecated. Renamed to jsx3.gui.DatePicker |
| jsx3.Dialog | Deprecated. Renamed to jsx3.gui.Dialog |
| jsx3.Document | Deprecated. Renamed to jsx3.xml.Document |
| jsx3.ERROR | Deprecated. Renamed to jsx3.util.Logger |
| jsx3.EVT | Deprecated. Use class jsx3.gui.Event instead. |
| jsx3.Entity | Deprecated. Renamed to jsx3.xml.Entity |
| jsx3.Event | Deprecated. Renamed to jsx3.gui.Interactive |
| jsx3.EventDispatcher | Deprecated. Renamed to jsx3.util.EventDispatcher |
| jsx3.Form | Deprecated. Renamed to jsx3.gui.Form |
| jsx3.Grid | Deprecated. Renamed to jsx3.gui.Grid |
| jsx3.Heavyweight | Deprecated. Renamed to jsx3.gui.Heavyweight |
| jsx3.HttpForm | Deprecated. Renamed to jsx3.net.Form |
| jsx3.HttpRequest | Deprecated. Renamed to jsx3.net.Request |
| jsx3.LayoutGrid | Deprecated. Renamed to jsx3.gui.LayoutGrid |
| jsx3.List | Deprecated. Renamed to jsx3.gui.List |
| jsx3.Menu | Deprecated. Renamed to jsx3.gui.Menu |
| jsx3.Model | Deprecated. Renamed to jsx3.app.Model |
| jsx3.RadioButton | Deprecated. Renamed to jsx3.gui.RadioButton |
| jsx3.Select | Deprecated. Renamed to jsx3.gui.Select |
| jsx3.Server | Deprecated. Renamed to jsx3.app.Server |
| jsx3.Service | Deprecated. Renamed to jsx3.net.Service |
| jsx3.Settings | Deprecated. Renamed to jsx3.app.Settings |
| jsx3.Slider | Deprecated. Renamed to jsx3.gui.Slider |
| jsx3.Splitter | Deprecated. Renamed to jsx3.gui.Splitter |
| jsx3.Stack | Deprecated. Renamed to jsx3.gui.Stack |
| jsx3.StackGroup | Deprecated. Renamed to jsx3.gui.StackGroup |
| jsx3.Tab | Deprecated. Renamed to jsx3.gui.Tab |
| jsx3.TabbedPane | Deprecated. Renamed to jsx3.gui.TabbedPane |
| jsx3.TextBox | Deprecated. Renamed to jsx3.gui.TextBox |
| jsx3.ToolbarButton | Deprecated. Renamed to jsx3.gui.ToolbarButton |
| jsx3.Tree | Deprecated. Renamed to jsx3.gui.Tree |
| jsx3.UserSettings | Deprecated. Renamed to jsx3.app.UserSettings |
| jsx3.WindowBar | Deprecated. Renamed to jsx3.gui.WindowBar |
| Field Summary | |
|---|---|
| static String | Deprecated. Use jsx3.getEnv("jsxabspath").
|
| static String | location for addin resources. |
| static String | Deprecated. Use jsx3.getEnv("jsxhomepath").
|
| static jsx3.app.Cache | Deprecated. Use getSharedCache() instead. |
| static jsx3.lang.ClassLoader | the system class loader. |
| static void | Deprecated. The new jsx3.lang.Class framework does not use this constant for instantiating objects.
|
| static jsx3.EVT | Deprecated. Static access to the event object is deprecated as it is not cross-platform. Access to the current
event object, where available, is granted via a method parameter or model event context variable. |
| static String | Deprecated. |
| static void | Deprecated. The new jsx3.lang.Class framework does not use this constant for instantiating objects.
|
| static jsx3.gui.Event | |
| static String | Deprecated. |
| static String | Deprecated. |
| Method Summary | |
|---|---|
| static void | Injects class jsx3.$Array into array instance a. |
| static void | Injects class jsx3.$Function into function instance f. |
| static void | Injects class jsx3.$Hash into object instance o. |
| static void | Injects class jsx3.$Object into object instance o. |
| static void | Injects class jsx3.$String into string instance s. |
| static Function | Wraps an asynchronous method. |
| static Function | Returns an asynchronous wrapper of a synchronous method. |
| static jsx3.app.Model | global call to get a handle to a specific JSX GUI Object; NOTE: This is a significant modification used to support
multi-instance servers. |
| static void | Deprecated. create classes using jsx3.Class |
| static void | Deprecated. create classes using jsx3.Class |
| static void | Deprecated. create classes using jsx3.Class |
| static void | Deprecated. use jsx3.Class.mixin() |
| static void | Evaluate a string of code with a particular local variable stack context. |
| static Object | getClassConstants(strClassName : String) Deprecated. use jsx3.lang.Class |
| static String | getClassMethods(strClassName : String) Deprecated. use jsx3.lang.Class |
| static String | |
| static String | getInstanceMethods(strClassName : String) Deprecated. use jsx3.lang.Class |
| static jsx3.app.Cache | Returns the global JSX XML/XSL cache. |
| static void | Returns the version of General Interface. |
| static void | Sends a message to the logging system. |
| static void | Deprecated. use jsx3.log() or the jsx3.util.Logger interface |
| static void | Ensures that one or more classes is available before this method returns. |
| static String | resolveURI(strURI : String | jsx3.net.URI) Returns a URI resolved against the default URI resolver, URIResolver.DEFAULT. |
| static void | A replacement for peppering code with window.setTimeout(fnct, 0) statements. |
| Field Detail |
|---|
jsx3.getEnv("jsxabspath").
jsx3.getEnv("jsxhomepath").
getSharedCache() instead.jsx3.app.Cache instance used by the JSX system to store XML and XSL documents.jsx3.lang.Class framework does not use this constant for instantiating objects.
jsx3.lang.Class framework does not use this constant for instantiating objects.
| Method Detail |
|---|
jsx3.$Array into array instance a.jsx3.$Function into function instance f.jsx3.$Hash into object instance o. If o is an array, it
is first converted into an object by setting a property equal to 1 for each item in the array.jsx3.$Object into object instance o.jsx3.$String into string instance s.jsx3.$AsyncCB. The wrapped method must call done() on this
method parameter, either synchronously or asynchronously. The done() method takes a single
parameter, which is the return value of the method.
The wrapped method should not itself return anything. The only exception to this is that the method may return
and instance of jsx3.$AsyncRV. In this case, the method will return when and with the same return
value as the returned instance of jsx3.$AsyncRV.
Client code that calls the asynchronous method will see a synchronous return value of type
jsx3.$AsyncRV. Client code should use the when() method of this return value to
continue execution when the asynchronous method has completed. Or this return value may be used in conjuction
with other asynchronous methods (such as by passing is as a parameter to an asynchronous method).
Another feature of asynchronous methods is that you can pass instances of jsx3.$AsyncRV as
parameters to the method and the method is only invoked once all of those parameters have returned. The parameters
that the wrapped method sees are automatically converted into the return values of the jsx3.$AsyncRV
instances.strMethod
bound to object objThis. objThis is optional and may be an object or an instance of
jsx3.$AsyncRV. If the latter, then the wrapped method is only called on the return value of
objThis after objThis returns.
The wrapper takes the same parameters as the wrapped method. However, instead of returning the return value of the
wrapped method, it returns an instance of jsx3.$AsyncRV.
The returned method may be passed parameters that are actually instances of jsx3.$AsyncRV. In this
case, the wrapped method is only actually called when all the parameters have returned.objThis to wrap.jsx3.Classjsx3.Classjsx3.Classjsx3.Class.mixin()jsx3.lang.Classjsx3.lang.Classjsx3.lang.ClassgetDocument() is called on the server cache with
a cache id that does not correspond to a document in the server cache.jsx3.util.Logger.GLOBAL.info().
Since this method is defined before the logging system, any messages passed to this method before the logging
system is defined are cached and sent with the first message passed after the logging system is defined.jsx3.log() or the jsx3.util.Logger interfacejsx3.util.Logger.doLog() (formerly jsx3.Error.doLog()).URIResolver.DEFAULT.window.setTimeout(fnct, 0) statements. This method places
all jobs in a queue. Each job gets its own stack.null and a job already
exists in the queue with this id, then this job is not added to the queue.objFunction when it is called.true and a job already exists, this new job clobbers the old job.Array class.| Fields Inherited From Array |
|---|
| length |
| Method Summary | |
|---|---|
| void | Appends the contents of a to this array. |
| boolean | Returns true if o is in this array. |
| void | Calls fct for each element in this array. |
| jsx3.$Array | Creates a new array with the filtered contents of this array. |
| Object | Returns the first element in this array for which fct returns true when passed the element as
the sole parameter. |
| int | Returns the first index of o in this array. |
| jsx3.$Array | Creates a new array using the mapped values of each element in this array. |
| Object | Removes the first occurrence of o in this array. |
| jsx3.$Array | unique() Returns a list containing only the unique elements in this list. |
| Methods Inherited From Array |
|---|
| clone, concat, contentsEqual, join, lastIndexOf, pop, push, pushAll, reverse, shift, slice, sort, splice, toString, unshift |
| Method Detail |
|---|
a to this array.o is in this array. This method uses strict equality for comparing objects
(===).fct for each element in this array. fct is passed each element as the
sole parameter.fct is called for
each element in this array and the element is passed as the sole argument. The new array is constructed with
only the elements of this array for which fct returns true.fct returns true when passed the element as
the sole parameter.o in this array. This method uses strict equality for comparing objects
(===).fct is called for
each element in this array and the element is passed as the sole argument. The new array is constructed with
the return values of each call to fct.
sole parameter.o in this array. This method uses strict equality for comparing objects
(===).undefined if o is not in this array.
| Method Summary | |
|---|---|
| Array<Object> | args() Returns the arguments that were passed to the asynchronous method wrapper. |
| void | Signals the callback object that the asynchronous method is done and passes the asynchronous return value. |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
| Method Summary | |
|---|---|
| jsx3.$AsyncRV | and(rv : jsx3.$AsyncRV...) Creates and returns an asynchronous return value that completes when this and rv have completed. |
| jsx3.$AsyncRV | or(rv : jsx3.$AsyncRV...) Creates and returns an asynchronous return value that completes when this or rv have completed. |
| Object | rv() Returns the return value from the asynchronous method. |
| void | Registers code to be called when the asynchronous method completes. |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
rv have completed.rv have completed.done() is called on corresponding callback object.
cb is a function, then that function will be called when the asynchronous method
completes. This function will be called synchronously is the function has already completed. The
asynchronous method return value will be passed as the only argument to the function.
If argument cb is an instance of jsx3.$AsyncCB, then its done() method
will be called when the asynchronous method completes. The done method will be passed the rv
argument it is is provided. Otherwise, it will be passed the return value of cb.Function class.| Method Summary | |
|---|---|
| jsx3.$Function | Returns a method that is this function applied to thisObj with arguments argsArr. |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
thisObj with arguments argsArr.Object class for emulating a hashtable.| Method Summary | |
|---|---|
| void | Iterates over all the key-value pairs of this hashtable. |
| jsx3.$Array | keys() Returns the list of keys of this hashtable. |
| jsx3.$Array | values() Returns the list of values of this hashtable. |
| Methods Inherited From jsx3.$Object |
|---|
| clone, extend |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
fct is called for each pair; the pair key
is the first parameter and the pair value is the second parameter.function(key : String, value: Object} : void
Object class.| Method Summary | |
|---|---|
| jsx3.$Object | clone() Creates a new objects with all the same properties as this object. |
| void | Copies all properties of o into this object. |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
o into this object.String class.| Method Summary | |
|---|---|
| boolean | Returns true if this string ends with string s. |
| jsx3.$String | trim() Returns this string with all leading and trailing space removed. |
| Methods Inherited From jsx3.$Object |
|---|
| clone, extend |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
s.jsx3.xml.Cacheable.| Field Summary | |
|---|---|
| static int | 0 |
| static int | 1 |
| Method Summary | |
|---|---|
| static int | Returns jsx3.Boolean.TRUE or jsx3.Boolean.FALSE. |
| Field Detail |
|---|
| Method Detail |
|---|
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.gui.Event instead.| Constructor Summary | |
|---|---|
| void | init(e : ?) Use this instance initializer for wrapped access to the current event object event at a later point in time. |
| Method Summary | |
|---|---|
| boolean | altKey() Returns true if the alt key was pressed |
| boolean | Returns true if the backspace key was pressed |
| int | button() Returns integer designating the mouse button clicked/moused-down/moused-up; 1 (left), 2 (right), and as supported |
| void | cancels event bubbling for the event
|
| void | cancels the key from firing by setting the keyCode to 0 (zero) for the event
|
| void | cancels the returnValue for the event
|
| int | clientX() Returns the clientX property for the event (where it occurred on-screen) |
| int | clientY() Returns the clientY property for the event (where it occurred on-screen) |
| boolean | ctrlKey() Returns true if the ctrl key was pressed |
| boolean | Returns true if the delete key was pressed |
| boolean | Returns true if the down-arrow key was pressed |
| boolean | endKey() Returns true if the end key was pressed |
| boolean | enterKey() Returns true if the enter key was pressed |
| boolean | Returns true if the escape key was pressed |
| Object | event() Returns handle to the native browser event object (window.event) |
| boolean | exists() Returns true if the native event object is present (if an event of any type actualy occurred) |
| HTMLElement | Returns handle to the HTML element that was moused away from (onmouseout) |
| int | getTrueX() Returns the actual position in the browser from the left edge for where the event occurred; |
| int | getTrueY() Returns the actual position in the browser from the top edge for where the event occurred; |
| Object | Deprecated. use jsx3.gui.Event.publish() instead
|
| boolean | homeKey() Returns true if the home key was pressed |
| boolean | Returns true if the insert key was pressed |
| int | keyCode() Returns integer representing the key code of the key just pressed/keyed-down |
| boolean | Returns true if the left-arrow key was pressed |
| boolean | Returns true if the left-mouse-button was clicked |
| boolean | Returns true if the page-down key was pressed |
| boolean | Returns true if the page-up key was pressed |
| void | Deprecated. use jsx3.gui.Event.subscribe instead |
| boolean | Returns true if the right-arrow key was pressed |
| boolean | Returns true if the right-mouse-button was clicked |
| void | setKeyCode(intKeyCode : int) sets/updates the keycode for the event |
| void | sets string message to set on the returnValue for the event |
| boolean | shiftKey() Returns true if the shift key was pressed |
| boolean | spaceKey() Returns true if the space bar was pressed |
| HTMLElement | Returns handle to the HTML element acted upon (click, mousedown, etc) |
| boolean | tabKey() Returns true if the tab key was pressed |
| HTMLElement | Returns handle to the HTML element that was moused over (onmouseover) |
| boolean | upArrow() Returns true if the up-arrow key was pressed |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
event at a later point in time.
| Method Detail |
|---|
bReturn is true, otherwise no return statement | Class Summary | |
|---|---|
| jsx3.amp.Bindable | |
| jsx3.amp.Engine | An AMP engine. |
| jsx3.amp.Ext | An AMP extension. |
| jsx3.amp.ExtPoint | An AMP extension point. |
| jsx3.amp.ExtProc | An extension processor utility class. |
| jsx3.amp.PlugIn | An AMP plug-in. |
| jsx3.amp.Resource | An AMP plug-in resource, such as a JavaScript file or XML file. |
| jsx3.amp.XML | An XML wrapper that can be backed either by a real XML node or by a nested object structure. |
| Field Summary | |
|---|---|
| static String | The name of the plug-ins registration file. |
| static String | The path where application plug-ins should reside. |
| static String | The name of a plug-in descriptor file. |
| static String | The plug-in definition XML namespace URI. |
| Field Detail |
|---|
| Method Summary | |
|---|---|
| void | Adds a bindable property to this object. |
| jsx3.$Array<String> | Returns the list of bindable properties of this object. |
| void | Sets the current calculated value of a bindable property of this object. |
| void | updateBindable(key : String) Causes a bindable property of this object to be recalculated. |
| void | Causes a bindable property to be updated when publisher publishes an event with subject
subject. |
| Method Detail |
|---|
{subject: propName, oldValue: previousValue, value: newValue}.key.publisher publishes an event with subject
subject.| Field Summary | |
|---|---|
| static String | Event subject published when an error prevents the engine from loading. |
| static String | Event subject published when an engine finishes loading. |
| static String | Event subject published when progress is made loading an engine. |
| static String | Event subject published when a plug-in is registered. |
| Method Summary | |
|---|---|
| void | deregister(strId : String) Deregisters a plug-in from this engine. |
| static jsx3.amp.Engine | getEngine(objServer : jsx3.app.Server) Returns the engine for a given application. |
| jsx3.amp.ExtPoint | getExtPoint(strId : String) Returns a registered extension point by ID. |
| jsx3.$Array<jsx3.amp.Ext> | Returns the extensions registered for a given extension point ID. |
| jsx3.amp.PlugIn | Returns a registered plug-in by ID. |
| jsx3.$Array<jsx3.amp.PlugIn> | Returns all registered plug-ins. |
| jsx3.app.Server | Returns the application associated with this engine. |
| boolean | isLoaded() Returns true if all of the AMP and project plug-ins have been registered. |
| jsx3.$AsyncRV | Registers a plug-in manually at runtime. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
pct and done
fields may be defined. | Method Detail |
|---|
| Method Summary | |
|---|---|
| jsx3.$Array<jsx3.amp.XML> | getData() Returns the list of XML elements declared in the body of the extension declaration. |
| jsx3.amp.Engine | Returns the engine owning the plug-in owning this extension. |
| String | getId() Returns the full ID of this extension, which is unique among all extensions in the AMP engine. |
| String | Returns the local ID of this extension, which is defined by the id attribute of the XML
extension declaration. |
| String | getName() Returns the name of this extension, which is defined by the name attribute of the XML
extension declaration. |
| jsx3.amp.PlugIn | Returns the plug-in declaring this extension. |
| jsx3.amp.ExtPoint | getPoint() Returns the extension point to which this extension is registered. |
| String | Returns the ID of the extension point this this extension extends. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
id attribute of the XML
extension declaration.name attribute of the XML
extension declaration.point
attribute of the XML extension declaration.| Field Summary | |
|---|---|
| static String | An event published by an extension point when it is extended by a new extension. |
| Method Summary | |
|---|---|
| jsx3.amp.Engine | Returns the engine owning the plug-in owning this extension point. |
| jsx3.$Array<jsx3.amp.Ext> | getExts() Returns the list of extensions registered with this extension point. |
| String | getId() Returns the full ID of this extension, which is unique among all extension points in the AMP engine. |
| String | Returns the local ID of this extension point, which is defined by the id attribute of the XML
extension point declaration. |
| String | getName() Returns the name of this extension point, which is defined by the name attribute of the XML
extension point declaration. |
| jsx3.amp.PlugIn | Returns the plug-in declaring this extension point. |
| void | onExtension(arrExts : jsx3.$Array<jsx3.amp.Ext>) This method is called (after this extension point is instantiated) any time extensions are registered for this
point. |
| jsx3.$Array<Object> | Processes each extension of this extension point using the visitor pattern. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Method Detail |
|---|
id attribute of the XML
extension point declaration.name attribute of the XML
extension point declaration.jsxsuper().| Field Summary | |
|---|---|
| static jsx3.amp.ExtProc | Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate. |
| static jsx3.amp.ExtProc | Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate. |
| static jsx3.amp.ExtProc | Processes an extension by intepreting each child element of the XML extension declaration as code to evaluate. |
| Method Summary | |
|---|---|
| static void | Registers a processor factory. |
| static void | Creates a processor object from a |
| static jsx3.amp.ExtProc | newDescrProc(objClass : String | jsx3.lang.Class | Function) Creates a new extension processor that creates instances of a certain class. |
| static jsx3.$Array | Processes a list of extensions using the visitor pattern. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
this.getPlugIn()
grants access in the script to the plug-in defining the extension.
No value is returned from the extension processing. If the load attribute of the eval
element is equal to "true" then the plug-in owning the extension is loaded before the script is evaluated.
Therefore, the script may be evaluated either synchronously or asynchronously, but since there is no value returned
from the processing, there is no way of knowing which one actually occurred.
this.getPlugIn()
grants access in the script to the plug-in defining the extension.
The value that the script evaluates to is returned from the extension processing.
this.getPlugIn()
grants access in the script to the plug-in defining the extension.
The value returned from the extension processing is an asynchronous return value as defined in the contract for
jsx3.$Y(). The return value may be notified either asynchronously or synchronously, depending on
whether the load attribute of the eval element is equal to "true". If it is, then
the plug-in owning the extension is loaded first and then the script is evaluated asynchronously. The asynchronous
return value is notified of completion with the value that the script evaluates to.
| Method Detail |
|---|
<processor> is found as a child of an <extension-point> element. Each processor element must
declare a type attribute. The factory that has been registered with the matching type is used to create
the processor. The method signature of the factory method is:
function(xml : jsx3.amp.XML) : jsx3.amp.ExtProc where xml is the XML representation
of the <processor> element.<processor> element.<processor> element.<processor> element.function init(ext : jsx3.amp.Ext, xml : jsx3.amp.XML).
The processing visitor will create a new instance of objClass for each child element of each
extension. If any child element defines a ext-class attribute, this is interpreted as the
fully-qualified class name of a subclass of objClass. This class, if it is defined, will be used
instead of objClass to process that particular child element.arrExt, this
method iterates over each child element of the extension declaration and invokes objVisitor for
each element. At each iteration the visitor is passed as arguments the extension object and an XML object
representing the child element.process(ext : jsx3.amp.Ext, data: jsx3.amp.XML) : Object or the function itself.| Field Summary | |
|---|---|
| static String | Event subject published when an extension point of this plug-in has been extended. |
| static String | Event subject published when this plug-in has loaded completely. |
| Method Summary | |
|---|---|
| jsx3.amp.Engine | Returns the engine of this plug-in. |
| jsx3.$Array<String> | Returns the list of event subjects that this plug-in declares to publish. |
| jsx3.amp.Ext | Returns an extension of this plug-in by its ID. |
| jsx3.amp.ExtPoint | getExtPoint(strId : String) Returns an extension point of this plug-in by its ID. |
| jsx3.$Array<jsx3.amp.ExtPoint> | Returns the extension points of this plug-in. |
| jsx3.$Array<jsx3.amp.Ext> | getExts() Returns the extensions of this plug-in. |
| String | getId() Returns the id attribute from the plug-in configuration element. |
| jsx3.util.Logger | getLog() Returns a logger for this plug-in. |
| String | getName() Returns the name attribute from the plug-in configuration element. |
| jsx3.$Array<String> | Returns the list of plug-in IDs that this plug-in requires. |
| jsx3.amp.Resource | getResource(strId : String) Returns a resource of this plug-in by its ID. |
| jsx3.$Array<jsx3.amp.Resource> | Returns the resources of this plug-in that are defined in the plug-in configuration data. |
| jsx3.app.Server | Returns the server of the engine of this plug-in. |
| String | Implements jsx3.net.URIResolver. |
| String | Returns the version attribute from the plug-in configuration element. |
| static void | isBindExpr(e : String) Returns true if e is a binding expression. |
| boolean | isGlobal() Returns whether this is a global plug-in. |
| boolean | isLoaded() Returns true is all of the resources of this plug-in have loaded. |
| jsx3.$AsyncRV | load() Loads this plug-in asynchronously if it is not already loaded. |
| void | loadRsrcComponent(strRsrcId : String | jsx3.amp.Resource, objParent : jsx3.app.Model, bPaint : boolean) Loads the contents of a plug-in resource as a GUI component. |
| void | Called (after this plug-in is instantiated) any time extensions are registered for an extension
point of this plug-in. |
| void | onLoaded() Called when all the resources of this plug-in have loaded. |
| void | Calls when this plug-in is registered with its engine. |
| void | Called when the engine of this plug-in has completely registered all plug-ins. |
| void | Registers a function to be called when the value of a binding expression changes. |
| jsx3.net.URI | Implements jsx3.net.URIResolver. |
| jsx3.net.URI | resolveURI(strURI : String | jsx3.net.URI) Implements jsx3.net.URIResolver. |
| void | setData(objElm : jsx3.xml.Entity) Called after this plug-in is instantiated to provide the plug-in with its XML configuration data. |
| void | setEngine(objEngine : jsx3.amp.Engine) Called after this plug-in is instantiated to provide the plug-in with the engine that created it. |
| void | Called after this plug-in is instantiated to provide the plug-in with its path. |
| void | setResources(arrRsrc : Array<jsx3.amp.Resource>) Called after this plug-in is instantiated to provide the plug-in with the resources defined in the
configuration data. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.amp.Bindable |
|---|
| addBindableProp, getBindableProps, setBindableProp, updateBindable, updateBindableOn |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Method Detail |
|---|
true if e is a binding expression. A binding expression starts with '{'
and ends with '}'.getPlugIn() method on the root component object
that returns this component. In addition, if the root component object defines an onRsrcLoad()
method, that method is called.true).
jsxsuper to ensure that the EXTENDED event is published.handler will be invoked any time one of these
bindable properties changes value. This function is passed the value of the binding expression. The binding
expression is evaluated in the context of this object. The "this" keyword is optional in the expression
because the expression is evaluated inside of a with block.jsx3.net.URIResolver.jsx3.net.URIResolver.| Field Summary | |
|---|---|
| static String | Loads a resource before the plug-in is instantiated and registered. |
| static String | Waits for a resource to be loaded programatically some time after the plug-in loads. |
| static String | Loads a resource before the plug-in loads. |
| static String | Event subject published when this resource has loaded. |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | |
| Method Summary | |
|---|---|
| void | Returns the value of any attribute of the XML declaration of this resource. |
| jsx3.xml.Document | jsx3.app.Properties | jsx3.app.PropsBundle | Returns the data associated with this resource. |
| String | getId() Returns the full ID of this resource, which is unique to the entire AMP engine. |
| String | Returns the load type, such as LOAD_NORMAL. |
| String | Returns the ID Of this resource, which is unique among all resources of the same plug-in. |
| Array<String> | Returns the list of locale keys for which this resources is localized. |
| String | getPath() Returns the path of this resource, which is relative to the directory of the plug-in owning this resource. |
| String | getPathForLocale(objLocale : jsx3.util.Locale) Returns the path of the best localized version of this resource for objLocale. |
| jsx3.amp.PlugIn | Returns the plug-in that owns this resource. |
| String | getType() Returns the resource type, such as TYPE_SCRIPT. |
| boolean | isLoaded() |
| jsx3.$AsyncRV | load() Asynchronously loads this resource if it is not already loaded. |
| jsx3.$AsyncRV | loaded() Returns an asynchronous return value that completes when this resource is loaded. |
| jsx3.xml.Entity | xml() Returns the XML declaration of this resource as passed to the constructor. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
true then delete the reference to the data object in order to allow
garbage collection.LOAD_NORMAL. The load type is defined using the load
attribute of the resource XML declaration.id attribute of the resource XML declaration.objLocale.TYPE_SCRIPT. The resource type is defined by the element
node name of the resource XML declaration.name() property equal to the base node namechildren() property that is an array of nested objects| Constructor Summary | |
|---|---|
| void | init(elm : jsx3.xml.Entity | Object) |
| Method Summary | |
|---|---|
| String | Returns an attribute of this element. |
| jsx3.amp.XML | Returns a child element of this element whose base name is equal to name. |
| jsx3.$Array<jsx3.amp.XML> | children() Returns this child elements of this element. |
| String | nname() Returns the base name of this element. |
| String | value() Returns the node value of this element. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
name.| Class Summary | |
|---|---|
| jsx3.amp.util.Menu | A managed menu. |
| jsx3.amp.util.MenuItem | A managed menu item. |
| jsx3.amp.util.MenuManager | Manages a set of menus. |
| jsx3.amp.util.Prefs | A preferences panel. |
| jsx3.amp.util.PrefsPane | A pane in a preferences panel. |
| jsx3.amp.util.ToolbarItem | Manages a toolbar. |
| jsx3.amp.util.ToolbarManager | Manages a toolbar. |
| jsx3.amp.util.Wizard | A wizard. |
| jsx3.amp.util.WizardPane | A pane of a wizard. |
jsx3.amp.util.menumgr plug-in.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | Adds an item to this menu. |
| void | Adds a logical section to this menu. |
| String | getId() Returns the ID of this menu. |
| jsx3.amp.util.MenuItem | Returns the item in this menu whose ID is equal to id. |
| jsx3.$Array<jsx3.amp.util.MenuItem> | getItems() Returns all items in this menu. |
| jsx3.gui.Menu | Returns the native GI menu that was rendered for this AMP menu. |
| String | getPath() Returns the path of this menu. |
| jsx3.xml.Document | getXML() Returns the CDF data source for this menu. |
| void | Called just before this menu is expanded. |
| Methods Inherited From jsx3.amp.util.MenuItem |
|---|
| attr, execute, getExt, getHotKey, getImg, getLabel, getMenu, getRootMenu, getTip, isEnabled, isSelected |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
id.objElm,
for example by enabling or selecting menu items or generating menu items on the fly.jsx3.amp.util.menumgr plug-in.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns an attribute of the XML declaration of this menu item. |
| void | execute() Executes this menu item. |
| jsx3.amp.Ext | getExt() Returns the extension that defined this menu item. |
| String | Returns the accelerator key code of this menu item. |
| String | getId() Returns the full ID of this menu item. |
| String | getImg() Returns the resolved image path of this item. |
| String | getLabel() Returns the label of this menu item. |
| jsx3.amp.util.Menu | getMenu() Returns the menu that contains this menu item. |
| String | getPath() Returns the path of this menu item. |
| jsx3.amp.util.Menu | |
| String | getTip() Returns the tip of this menu item. |
| boolean | Returns whether this menu item is enabled. |
| boolean | Returns whether this menu item is selected. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
execute attribute is not empty then the plug-in that
declared this menu item is loaded. Once the plug-in loads the contents of the execute attribute
are execute in the context of the extension that defined this menu item.
enabled attribute of the item definition. Otherwise this method returns true.selected attribute of the item definition. Otherwise this method returns false.jsx3.amp.util.menumgr plug-in.
| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| void | addItem(objItem : jsx3.amp.util.MenuItem) Adds a menu item to this manager. |
| void | addMenu(objMenu : jsx3.amp.util.Menu) Adds a menu to this manager. |
| void | Adds a menu bar to this manager. |
| void | Paints all the menus in this manager into their respective menu bars. |
| void | Returns the menu with full path strPath. |
| jsx3.$Array<jsx3.amp.util.Menu> | getMenus() Returns all the menus in this manager. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
strPath will be inserted into the menu bar.strPath.jsx3.amp.util.prefspanel plug-in.
| Field Summary | |
|---|---|
| static String | Event subject published when a preferences panel is saved. |
| static String | Event subject published when the active pane of a preferences panel is changed. |
| static String | Event subject published when a preferences panel is closed. |
| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| void | addPane(objPane : jsx3.amp.util.PrefsPane) Adds a prefs pane to this controller. |
| void | apply() Saves the state of the current pane. |
| boolean | Returns whether to collapse the left side pane list. |
| void | Renders the preferences panel in objParent. |
| void | save() Saves the state of the current pane and closes this panel. |
| void | setCollapse(bCollapse : boolean) Sets whether to collapse the left side pane list. |
| jsx3.$AsyncRV | Displays a prefs pane in the edit area. |
| jsx3.$AsyncRV | Removes this preferences panel from the view. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
renderIn()
has been called.objParent.true only if the pane was shown successfully.true, the current pane is unloaded without saving changes.
true only if the preferences panel was unloaded successfully.jsx3.amp.util.prefspanel plug-in.
| Field Summary | |
|---|---|
| static String | Event subject published when the state of a preference pane is dirtied. |
| static String | Event subject published when a preference pane is saved. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the description of this pane. |
| jsx3.app.Model | Returns the object in the UI of this pane that should get focus when this pane is first revealed. |
| String | getImage() Returns the resolved path of the image of this pane. |
| Object | getProperty(strId : String) Returns an arbitrary property of this pane. |
| String | getTitle() Returns the title of this pane. |
| jsx3.app.Model | getUI() Returns the root component of this pane once it is rendered. |
| boolean | isDirty() Returns whether this pane has unsaved changes. |
| jsx3.$AsyncRV | save() Saves the state of this pane. |
| void | Sets whether this pane has unsaved changes. |
| void | Sets an arbitrary property of this pane. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
obj parameter must define an attribute, resource, which
is the name of an XML resource of ext. This resource will be loaded as the UI component of this
pane. The root object of this component file may define the following methods:
| Method Detail |
|---|
getFirstResponder() of the root UI component for this pane,
if that method is defined.savePrefs() method of the root
UI component of this pane.
jsx3.amp.util.toolbarmgr plug-in.
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | getImg() Returns the resolved image path of this toolbar item. |
| String | Returns the section of this toolbar item. |
| String | getTip() Returns the tip of this toolbar item. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.amp.util.toolbarmgr plug-in.
| Constructor Summary | |
|---|---|
| void | init(objToolbar : jsx3.gui.WindowBar) The instance initializer. |
| Method Summary | |
|---|---|
| void | addItem(objItem : jsx3.amp.util.ToolbarItem) |
| void | |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.amp.util.wizard plug-in.
| Field Summary | |
|---|---|
| static String | Event subject published when a wizard is cancelled. |
| static String | Event subject published when a wizard is finished. |
| static String | Event subject published when a wizard advances to the next pane. |
| static String | Event subject published when a wizard advances to the previous pane. |
| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| void | Adds a pane to this wizard. |
| void | cancel() Invokes the cancel button. |
| void | finish() Invokes the finish button. |
| jsx3.amp.util.WizardPane | Returns a pane of this wizard by its index. |
| int | Returns the number of panes in this wizard. |
| int | Returns the index of a pane of this wizard. |
| Object | Returns the wizard session object. |
| void | next() Invokes the next button. |
| void | previous() Invokes the previous button. |
| void | removePane(index : int) Removes a pane from this wizard by its list index. |
| void | renderIn(objContainer : jsx3.app.Model) Renders the wizard UI as a child of objContainer. |
| void | Updates the enabled button states of the four wizard buttons. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
objContainer.jsx3.amp.util.wizard plug-in.
| Constructor Summary | |
|---|---|
| jsx3.app.Model | The instance initializer. |
| Method Summary | |
|---|---|
| jsx3.app.Model | Returns the object in the UI of this pane that should be focused when the pane is revealed. |
| String | getTitle() Returns the title of this pane. |
| jsx3.app.Model | getUI() Returns the root UI component of this pane once it has been rendered. |
| jsx3.amp.util.Wizard | Returns the wizard owning this pane. |
| boolean | Returns true if the cancel button should be enabled. |
| boolean | Returns true if the finish button should be enabled. |
| boolean | mayNext() Returns true if the next button should be enabled. |
| boolean | Returns true if the previous button should be enabled. |
| void | Called when this pane is revealed. |
| void | Called when this pane is hidden. |
| void | onNext() Called when the UI requests continuing to the next pane. |
| void | Called when the UI requests backtracking to the previous pane. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
getFirstResponder() method of the UI component, if that method is defined.true if the cancel button should be enabled.true if the finish button should be enabled.true if the next button should be enabled.true if the previous button should be enabled.onReveal() method of the root UI component, if that
method is defined.onConceal() method of the root UI component, if that
method is defined.ok field equal to false.{ok:Boolean, alert:Boolean, title:String, message:String}
ok field equal to false.{ok:Boolean, alert:Boolean, title:String, message:String}
| Class Summary | |
|---|---|
| jsx3.app.AddIn | A class that represents a JSX add-in. |
| jsx3.app.Cache | Provides cached access to XML and XSL data. |
| jsx3.app.DOM | Registers all DOM nodes in an instance of jsx3.app.Server and publishes related events. |
| jsx3.app.Model | The abstract base class that defines the JSX DOM. |
| jsx3.app.Monitor | A logging handler that can be instantiated per JSX application and displays logging messages in a separate
browser window while an application is running. |
| jsx3.app.Properties | Represents a repository of dynamic properties. |
| jsx3.app.PropsBundle | A subclass of jsx3.app.Properties that supports localized properties. |
| jsx3.app.Server | The controller of the JSX architecture. |
| jsx3.app.Settings | An object oriented interface onto the XML system settings format. |
| jsx3.app.UserSettings | Read-Write per-User settings for a particular GI application (server). |
| Field Summary | |
|---|---|
| static String | |
| Method Summary | |
|---|---|
| String | |
| String | getId() |
| String | getKey() |
| String | getName() |
| jsx3.app.Settings | |
| String | |
| String | |
| jsx3.net.URI | |
| jsx3.net.URI | resolveURI(strURI : String | jsx3.net.URI) |
| String | toString() |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Method Detail |
|---|
subject - Cache.CHANGE
id or ids - the ID or array of IDs of the modified documentsaction - Cache.ADD, Cache.CHANGE or Cache.REMOVE
subject - the cache ID of the modified documentaction - Cache.ADD, Cache.CHANGE or Cache.REMOVE
getOrOpenAsync() method. This method returns
the corresponding document synchronously if it already exists in the cache. If the document does not exist in the
cache, then it is loaded asynchronously and the method returns a placeholder document. The namespace URI of this
placeholder document is Cache.XSDNS and its root node name is "loading".
Since the cache stores this placeholder document until the document finishes loading, subsequent calls to
synchronous APIs (getDocument(), getOrOpenDocument(), etc) may also return the
placeholder document. It is therefore important to check the namespace of the returned document when any code
uses the asynchronous APIs.
Once a document finishes loading asynchronously the placeholder document is replaced with the loaded document.
This change in value causes the cache to publish a pair of events of action Cache.CHANGE. If
loading the document fails or times out the placeholder document is instead replaced with another placeholder
document. This document also has a URI namespace of Cache.XSDNS. Its root node name may be either
"error" or "timeout". If the root node name is "error" then the root node
has an attribute, also named "error", which contains the XML error message.
| Field Summary | |
|---|---|
| static String | Event action. |
| static int | The number of milliseconds before asynchronous document loads time out. |
| static String | Event subject and action. |
| static String | Event action. |
| static String | |
| Constructor Summary | |
|---|---|
| void | init() Creates a new instance of this class. |
| Method Summary | |
|---|---|
| jsx3.xml.Document | Removes the document stored in this cache under id strId. |
| Array<String> | clearByTimestamp(intTimestamp : int | Date) Removes all documents placed in this cache before intTimestamp. |
| void | destroy() Removes all references to documents contained in this cache. |
| jsx3.xml.Document | getDocument(strId : String) Returns the document stored in this cache under id strId. |
| jsx3.xml.Document | Asynchronously loads an xml document and stores it in this cache. |
| jsx3.xml.Document | Retrieves a document from this cache or, if this cache contains no such document, loads the document
synchronously and returns it. |
| int | getTimestamp(strId : String) Returns the timestamp from when the document stored under id strId was stored in this cache. |
| boolean | Deprecated. |
| Array<String> | keys() Returns a list of all the keys in this cache instance. |
| jsx3.xml.Document | Synchronously loads an xml document, stores it in this cache, and returns the loaded document. |
| void | Stores the document objDocument in this cache under id strId. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
strId.intTimestamp.strId.null if none exists.
strURL parameter is used as the id.jsx3.xml.Document (default value) or one of its subclasses. The
class with which to instantiate the new document instance.strURL parameter is used as the id.jsx3.xml.Document (default value) or one of its subclasses. The
class with which to instantiate the new document instance if a new document is opened.strId was stored in this cache.null if no such document exists
in this cache.
false. strURL parameter is used as the id.jsx3.xml.Document (default value) or one of its subclasses. The
class with which to instantiate the new document instance.objDocument in this cache under id strId. If a document already
exists in this cache under strId then that document is removed from the cache.objDocument.jsx3.app.Server and publishes related events.
This class keeps all contained JSX objects indexed on id and name.
| Field Summary | |
|---|---|
| static int | 0 |
| static int | 2 |
| static int | 1 |
| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| void | add(objJSX : jsx3.app.Model) Adds a JSX object to this DOM and indexes it by its id and name. |
| void | destroy() The instance finalizer. |
| jsx3.app.Model | Looks up a DOM object contained in this DOM by id or name. |
| Array<jsx3.app.Model> | getAllByName(strName : String) Returns all the DOM nodes in this DOM with a name of strName. |
| jsx3.app.Model | Looks up a DOM object contained in this DOM by id. |
| jsx3.app.Model | Looks up a DOM object contained in this DOM by name. |
| static String | Creates a new unique system id. |
| void | called when a change to the JSX DOM occurs for this server instance (adopt, load, delete, etc); publishes an event object (javascript object) with the following named properties: subject (jsx3.app.DOM.EVENT_CHANGE); type (jsx3.app.DOM.TYPEADD | jsx3.app.DOM.TYPEREMOVE); parentId (id of JSX parent); jsxId (id of element added or removed) |
| void | A method that must be called after changing the name of a contained DOM node. |
| void | remove(objJSX : jsx3.app.Model) Removes a JSX object from this DOM and removes it from the indices. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
null if none found.
strName. The name index keeps a bucket of
DOM nodes for each unique name. Therefore, this method performs efficiently.null if none found.
strName the behavior of this method is undefined.null if none found. getChild(), adoptChild(), getParent(), etc.| Field Summary | |
|---|---|
| static int | The number of milliseconds before asynchronous component loads time out. |
| static String | Minimum supported version CIF formatted serialization files |
| static String | Minimum supported version for serialization files
|
| static int | The normal load type for a DOM branch. |
| static int | Load type indicating that the DOM branch will deserialize and paint as needed when it becomes visible. |
| static int | Load type indicating that the DOM branch will paint as needed when it becomes visible. |
| static int | Load type indicating that the DOM branch will deserialize and paint after its parent deserializes and the
call stack resets. |
| static int | Load type indicating that the DOM branch will paint after its parent paints and the call stack resets. |
| static int | Load type indicating that the DOM branch will deserialize after its parent deserializes and the call stack
resets and will paint after its parent paints and the call stack resets. |
| static Object<String, boolean> | The allowed meta data fields. |
| static int | Normal persistance value for a child that will be persisted. |
| static int | Persistance value fora child that is temporarily part of the DOM tree and will not be persisted. |
| static int | Persistance value for a child that exists in an external serialization file and is referenced by URI. |
| static int | Persistance value for a child that exists in an external serialization file and is referenced by URI. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | Appends a DOM node to this object after removing the node from its former parent reference. |
| jsx3.app.Model | Creates and returns an exact replica of the object. |
| jsx3.app.Model | Returns the first ancestor passing the given test function. |
| jsx3.app.Model | Array<jsx3.app.Model> | findDescendants(fctTest : Function, bDepthFirst : boolean, bMultiple : boolean, bShallow : boolean, bIncludeSelf : boolean) Finds all DOM nodes descending from this DOM node that pass the given test function. |
| jsx3.app.Model | getAncestorOfName(strName : String) Returns the first ancestor with the given name. |
| jsx3.app.Model | getAncestorOfType(strType : String | Function | jsx3.lang.Class) Returns the first ancestor of the given type. |
| jsx3.app.Model | Returns the child DOM node of this node at the given index or with the given name. |
| int | Returns the zero-based index for this DOM node in relation to its siblings. |
| Array<jsx3.app.Model> | Returns an array containing all the child DOM nodes of this object. |
| jsx3.app.Model | Finds the first descendant of this DOM node with a the given name. |
| Array<jsx3.app.Model> | Finds all descendants of the given type. |
| jsx3.app.Model | Returns the first child. |
| jsx3.app.Model | Finds the first child of the given type. |
| String | Returns the help ID of this object. |
| String | getId() Returns the custom JSX-generated id for the object (i.e. |
| jsx3.app.Model | Returns the last child. |
| int | Returns the load type of this DOM node and the descending branch. |
| String | getMetaValue(strKey : String) Returns one of the meta data values stored at the top of the serialization file that this object was loaded from. |
| String | getNS() Returns the namespace that distinguishes this object's server (owner) from other server instances. |
| String | getName() Returns the custom developer-defined name of this object. |
| jsx3.app.Model | Returns the next sibling. |
| jsx3.app.Model | Returns the parent DOM node of this object. |
| int | Returns the persistence bit for this model object. |
| jsx3.app.Model | Returns the previous sibling. |
| jsx3.app.Server | Returns an object reference to the server that owns this object. |
| jsx3.net.URIResolver | Returns the URI resolver for this DOM node. |
| static String | Deprecated. |
| boolean | Assigns objMoveChild as the previousSibling of objPrecedeChild |
| jsx3.app.Model | Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node. |
| jsx3.app.Model | loadAndCache(strURL : String | jsx3.net.URI, bRepaint : boolean, objCache : jsx3.app.Cache, objResolver : jsx3.net.URIResolver) Loads a component file and caches the document in an XML cache. |
| jsx3.app.Model | loadXML(strXML : String | jsx3.xml.Document, bRepaint : boolean, objResolver : jsx3.net.URIResolver) Deserializes a JSX serialization file and appends the deserialized objects as children of this DOM node. |
| protected void | Called during deserialization of this object. |
| protected void | Called during deserialization of this object. |
| protected void | Called during deserialization of this object. |
| protected void | Called when the server owning this DOM node changes. |
| void | onChildAdded(objChild : jsx3.gui.Model) Hook that notifies the model object that a child has been added to it. |
| protected void | onDestroy(objParent : jsx3.app.Model) The finalizer method. |
| protected void | Hook that notifies this model object that one of its children has been removed. |
| protected boolean | onSetChild(objChild : ?) Hook that allows for a prospective parent DOM node to veto the adoption of a child. |
| protected boolean | onSetParent(objParent : ?) Hook that allows for a prospective child DOM node to veto its adoption by a parent. |
| jsx3.app.Model | removeChild(vntItem : int | jsx3.app.Model) Removes a DOM child from this object. |
| jsx3.app.Model | removeChildren(arrChildren : Array<int | jsx3.app.Model>) Removes some or all children of this object. |
| Array<jsx3.app.Model> | jsx3.app.Model | Select objects from the DOM using a CSS3-like selection syntax. |
| jsx3.app.Model | boolean | setChild(objChild : jsx3.app.Model, intPersist : int, strSourceURL : String | jsx3.net.URI, strNS : String) Appends a child DOM node to this parent DOM node. |
| void | Sets the help ID of this object. |
| void | setLoadType(intLoadType : int) Sets the load type of this DOM node and the descending branch. |
| void | setS one of the meta data values stored at the top of a component's serialization file. |
| void | Sets the custom developer-defined name of this object. |
| jsx3.app.Model | setPersistence(intPersist : int) Sets the persistence bit for this model object. |
| String | toString() Returns a string representation of this object. |
| String | Returns this object serialized as XML by calling toString() on the result of toXMLDoc()
called on this object. |
| jsx3.xml.Document | Serializes this object as an XML document. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
setChild() should be used instead of this method.true or null, the object being adopted will be added to
the parent's view via the parent's paintChild() method.
This parameter is made available for those situations where a loop is executing and multiple
objects are being adopted. As view operations are the most CPU intensive, passing false
while looping through a collection of child objects to adopt will improve performance. After the
last child is adopted, simply call repaint() on the parent to immediately synchronize the view.onSetChild() and onSetParent() will still be called)0 for insert as the last child of the parent of this object and paint,
1 for insert as the last child of this parent of this object and do not paint, or 2
for load as a fragment.jsx3.app.Model parameter and returns
true if the node matches.true, include this object in the searchjsx3.app.Model parameter and returns
true if the node matches.true, return an array of matches, otherwise just the first match.true, only search direct children.true, include this node in the search.null if none found.
jsx3.Class instance.null if none found.
null if no such
child exists.
-1 if this object does not have a parent.
true, only search the children of this DOM node.null if none found.
jsx3.Class instance.true, only search direct children, not all descendants.jsx3.Class instance.true then only return objects whose class is exactly strType
(rather than returning subclasses too).null if none found.
LT_NORMAL, LT_SLEEP_PAINT, LT_SLEEP_DESER,
LT_SLEEP_PD, LT_SHOW_PAINT, or LT_SHOW_DESER. META_FIELDS.PERSISTNONE, PERSISTEMBED, PERSISTREF,
PERSISTREFASYNC. null if this
object is part of a DOM fragment. Until an object is added to a DOM tree by passing it as the parameter to
setChild(), the object will be a DOM fragment.false the repaint will be suppressed (useful for multiple obejct updates
that would lead to unnecessary updates to the VIEW)objResolver, if provided, or the URI resolver of this DOM node.true or null the deserialized objects will be
added to the parent's view via the parent object's paintChild() method.strURL is resolved
relative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.strURL is not the URL of a valid XML document.load() when the same URL will be loaded multiple
times in one application.objResolver, if provided, or the URI resolver of this DOM node.true or null the deserialized objects will be
added to the parent's view via the parent object's paintChild() method.strURL is resolved
relative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.strURL is not the URL of a valid XML document.
true or null the deserialized objects will be
added to the parent's view via the parent object's paintChild() method.strXML is not a valid XML document.
getParent(), getServer(), getXML(), etc. return null.init() is not called. Called after this object has been
instantiated and after it has been attached to the DOM. Methods overriding this method should usually begin
with a call to jsxsuper().
When a new branch is attached to the DOM, this method is executed on each node in the branch. The order is
reverse-breadth-first meaning that child nodes are notified from oldest to youngest and before the parent node.
This implementation of this method executes the on-after-deserialize script of this object.getParent(), getServer(), getXML(), etc. return null.jsxsuper().
Note that this method is called after this object has been removed from the DOM tree. Therefore
this.getParent() and this.getServer() will return null. Use the
objParent parameter for access to the DOM tree.this.getChildren() does not contain objChild)
and after the child has been removed from the view (objChild.getRendered() is also null).
This method is only called if the child is being removed from the DOM but this object (the parent) is not
being removed. Therefore, this hook cannot be relied upon for garbage collection.
If removeChildren() is called on this object, this hook is called exactly once after all children
have been removed. In that case, the first parameter to this method will be the array of children and the
second parameter will be null.
In general a method overriding this method should begin by calling jsxsuper.onSetChild() method.adoptChild() should be used instead of this
method.jsx3_gui_ClassName - matches objects by their exact class. Replace "." with "_" in the selector.* - matches any object#id - matches objects whose name equals id
.class-name - matches objects for which getClassName() is defined and returns a
string that contains the token class-name
:first and :last - matches objects that are their parents' first and last children:nth(n) and nth-child(n) - matches objects whose child index is equal to n
:instanceof(ClassName) - matches objects that are instances of the class or interface ClassName
[prop="value"] and [prop*="value"] - matches objects whose value for field
prop equals value
value. The quotes around value are optional.
[getter()="value"] and [getter()*="value"] - matches objects whose return value for
method getter equals value
value. The quotes around value are optional.
AB - matches objects that match both A and BA B - matches descendants of objects matching A that match BA > B - matches immediate children of objects matching A that match Btrue, return only the first match.strExpr is an invalid selection query.adoptChild()
should be used instead to ensure that the child is removed from its current parent.intPersist is PERSISTREF or PERSISTREFASYNC.strNS parameter is not specified.false if the set was vetoed LT_NORMAL, LT_SLEEP_PAINT, LT_SLEEP_DESER,
LT_SLEEP_PD, LT_SHOW_PAINT, or LT_SHOW_DESER.META_FIELDSPERSISTNONE, PERSISTEMBED, PERSISTREF,
PERSISTREFASYNC.toString() on the result of toXMLDoc()
called on this object.toXMLDoc() for a description.objProperties parameter may include the following keys:
onAfterDeserialize elementonBeforeDeserialize elementname elementicon elementdescription elementtrue the children of this object, rather than this object, are
serializedtrue all descendants with persistence PERSISTNONE are included in the
serialization| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| boolean | Returns whether this monitor remains invisible until the user types the hotkey ctrl+alt+m in the attached
application. |
| boolean | Returns whether this monitor is disabled when its application is running inside the IDE. |
| String | Returns the server namespace of this monitor. |
| void | handle(objRecord : jsx3.util.Logger.Record) Writes the formatted logging message to a separate browser window if all relevant conditions are met. |
| void | setActivateOnHotKey(activateOnHotKey : boolean) Sets whether this monitor waits for the hotkey ctrl+alt+m before becoming visible. |
| void | setDisableInIDE(disableInIDE : boolean) Sets whether this monitor is disabled when its application is running inside the IDE. |
| void | setServerNamespace(serverNamespace : String) Sets the server namespace of this monitor. |
| Methods Inherited From jsx3.util.Logger.FormatHandler |
|---|
| getFormat, setFormat |
| Methods Inherited From jsx3.util.Logger.Handler |
|---|
| getLevel, getName, isLoggable, setLevel |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
ctrl+alt+m in the attached
application. If false this monitor will appear when the application is loaded and anytime the
monitor is closed and a logging message is received.ctrl+alt+m before becoming visible.| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| void | addParent(objParent : jsx3.app.Properties) Adds a parent property repository to this repository. |
| boolean | containsKey(strKey : String) Returns whether this property repository contains a particular property. |
| Object | undefined | Returns the value of a property for a particular key. |
| Array<String> | getKeys() Returns a list of all the property keys contained in this repository. |
| Array<jsx3.app.Properties> | Returns the list of parent repositories of this repository. |
| void | Loads a set of dynamic properties from an XML document into this repository. |
| void | Removes a property from this repository. |
| void | Removes all parent property repositories. |
| void | removeParent(objParent : jsx3.app.Properties) Removes a property repository from the set of parent repositories. |
| void | Sets a property in this repository in the global space. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
get() consults all parents before returning
undefined.true if this repository contains a property with the given key.
undefined is returned.record elements defined under the root data element.
The following CDF attributes are supported:
jsxid – the property key, required.jsxtext – the property value, required.eval – if "1" or "true" the jsxtext attribute
is evaluated with JavaScript, optional.null, in which case
null will be stored as the property value. This value may not be undefined; use
remove() to remove a property value.jsx3.app.Properties that supports localized properties. Using this class, an application
can define properties for a number of locales but only load the properties necessary to display a particular
locale. Additionally, this class supports fall-through so that if a property is not defined for a particular locale
that locale inherits the value from the next most specific locale.
A properties bundle can consist of one or more XML files. The main file, fileName.ext, contains the
properties for the default locale, as well as the properties for any number of other locales, and metadata
indicating what locales are available external to the main file. The format of this file is:
<data jsxnamespace="propsbundle" locales="externalLocales">
<!-- the default locale -->
<locale>
<record jsxid="propId" jsxtext="propValue"/>
...
</locale>
<!-- additional locales -->
<locale key="en_US">
<record jsxid="propId" jsxtext="propValueEnUs"/>
...
</locale>
...
</data>
externalLocales is a comma-separated list of locales that are available for this properties bundle that
are defined in separate files. By spreading a properties bundle over many files, loading a bundle for a single
locale is optimized. For each locale, locKey, listed in externalLocales, there must be a file
fileName.locKey.ext in the same directory as the main bundle file.
Each external file has the same format as the main file except that the locales attribute of
the data tag should not be specified. Any number of locales can be defined. The first locale defined
should be the locale explicit in the name of the file. Only more specific locales should follow this locale.
For example, file props.es.xml, should start by defining locale es and could continue
with locales es_ES and es_MX but should not define locales fr or
de.| Method Summary | |
|---|---|
| static void | Clears all the data stored in the caches internal to this class. |
| jsx3.app.Locale | Returns the locale for which this properties object was created. |
| String | getPath() Returns the base path of this properties bundle. |
| static jsx3.app.PropsBundle | getProps(strBasePath : String | jsx3.net.URI, objLocale : jsx3.util.Locale, objCache : jsx3.app.Cache) Returns a properties object representing a localized view onto a properties bundle. |
| static jsx3.app.PropsBundle | getPropsAsync(strBasePath : String | jsx3.net.URI, objLocale : jsx3.util.Locale, fctCallback : Function, objCache : jsx3.app.Cache) Returns a properties object representing a localized view onto a properties bundle. |
| Methods Inherited From jsx3.app.Properties |
|---|
| addParent, containsKey, get, getKeys, getParents, loadXML, remove, removeAllParents, removeParent, set |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
getProps()
consult only these caches. If files have changed on disk this method must be called for the return value of
getProps() to reflect these changes.strPath.strPath, clear out any documents
stored in objCache associated with the resource at path strPath.
getProps() method and not necessarily the most specific locale for which the
properties in this view are defined.| Field Summary | |
|---|---|
| jsx3.app.Cache | Deprecated. Use Server.getCache() |
| jsx3.app.DOM | Deprecated. Use Server.getDOM() |
| Object<String, String> | Deprecated. Use Server.getEnv() |
| static String | The subject of an event that instances of this class publish when a context help hot key is pressed
in the context of a DOM node that has a help ID. |
| static String | The subject of an event that jsx3.app.Server publishes when an instance of this class
is created. |
| jsx3.gui.Block | Deprecated. Use Server.getBodyBlock() |
| jsx3.gui.Block | Deprecated. Use Server.getRootBlock() |
| Constructor Summary | |
|---|---|
| void | Sets environment variables used by this class (the controller for the JSX architecture) |
| Method Summary | |
|---|---|
| jsx3.gui.Window | createAppWindow(strName : String) Creates a new jsx3.gui.Window instance for this server. |
| void | delete a cookie |
| void | destroy() call to shut down a server instance and free up resources used by the server (cache,dom,etc)
|
| jsx3.app.Model | To implement jsx3.gui.Alerts interface. |
| jsx3.gui.Window | getAppWindow(strName : String) Retrieves a previously created jsx3.gui.Window instance. |
| jsx3.gui.Block | Returns the body block for this server (JSXBODY) |
| jsx3.app.Cache | getCache() Returns the XML/XSL cache for this server |
| String | Returns the value for the Cookie with the given @name |
| jsx3.app.DOM | getDOM() Returns the DOM for this server |
| jsx3.util.Locale | Returns the default locale of this server. |
| HTMLDocument | getDocumentOf(objJSX : jsx3.app.Model) Returns the browser document object containing a particular JSX object. |
| String | Returns the value of the dynamic property @strPropName |
| String | Returns the value of an environment setting of this server. |
| jsx3.app.Model | Looks up a DOM node owned by this server by id or by name. |
| jsx3.app.Model | getJSXById(strId : String) Looks up a DOM node owned by this server by id. |
| jsx3.app.Model | getJSXByName(strId : String) Looks up a DOM node owned by this server by name. |
| jsx3.util.Locale | Returns the current locale of this server. |
| jsx3.app.Properties | Returns the dynamic properties registry for this server. |
| HTMLElement | getRenderedOf(objJSX : jsx3.app.Model) Returns the browser DOM object where a particulat JSX object renders. |
| jsx3.gui.Block | Returns the root block for this server (JSXROOT) |
| Array<jsx3.app.Model> | Returns the list of objects that are children of the body object. |
| jsx3.app.Server | Deprecated. |
| jsx3.app.Settings | Returns the settings of this server/project per config.xml |
| jsx3.gui.WindowBar | getTaskBar(objJSX : jsx3.app.Model) Returns handle to a descendant taskbar belonging to this server instance (this is where JSXDialog instances will try to minimize to if it exists); returns null if none found;
if no taskbar is found, dialogs are not minimized, but are 'window shaded'—like a Mac used to do |
| String | |
| static String | Deprecated. |
| void | invokeHelp(objJSX : jsx3.app.Model) Invokes context-sensitive help as though the user had pressed the help hot key in the context of the DOM node
objJSX. |
| jsx3.gui.Window | Loads a new jsx3.gui.Window instance from a component file. |
| jsx3.xml.Document | jsx3.net.Service | null | Loads an external resource into this server instance. |
| jsx3.xml.Document | jsx3.net.Service | null | loadResource(strId : String) Loads an application resource. |
| void | paint(objXML : jsx3.xml.Document) Paints this application and its default component into the application view port on the host HTML page. |
| jsx3.net.URI | |
| void | Reloads all resource files that are localized. |
| jsx3.net.URI | resolveURI(strURI : String | jsx3.net.URI) Resolves a URI that is referenced from a file in this server. |
| void | setCookie(name : String, value : String, expires : Date, path : String, domain : String, secure : boolean, bRaw : ?) Sets a Cookie with the given name and value |
| void | set all four dimensions for a jsx3.Server instance, allowing the developer to adjust the width/height/left/width for the server. |
| void | updates a single dynamic style property; dynamic properties are used by jsx3.gui.Block objects that extend the astract class, jsx3.gui.Block; |
| void | setLocale(objLocale : jsx3.util.Locale) Sets the locale of this server. |
| String | toString() |
| void | unloadInclude(strId : String) Removes a loaded JavaScript or CSS resource from the browser DOM. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.gui.Alerts |
|---|
| alert, configureAlert, confirm, prompt |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
Server.getCache()Server.getDOM()Server.getEnv()target - the server publishing the event.model - the DOM node that received the key event.helpid - the help ID of the nearest ancestor of model that defines a help ID.jsx3.app.Server publishes when an instance of this class
is created. The target of the event object is the initialized server.
Server.getBodyBlock()Server.getRootBlock()| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.gui.Window instance.null if no such window exists. default_locale configuration
setting.jsx3.gui.Window roots.setLocale(),
that locale is returned. Otherwise, getDefaultLocale() is consulted, and finally the system-wide
locale.jsx3.gui.Window roots.objJSX.strSource is resolved
relative to it. Additionally, this resolver is stored as the URI resolver for this DOM node and its descendants.strType
parameter.
script - Loads a JavaScript file asynchronously into the memory space of the page hosting this
application; returns null.css - Loads a CSS file asynchronously into the memory space of the page hosting this
application; returns null.xml or xsl - Loads an XML file synchronously into the XML cache of this
application; returns the loaded jsx3.xml.Document instance.jss or ljss - Loads a dynamic properties file or localized properties bundle
synchronously into this application; returns null.services - Loads and parses a mapping rules file synchronously; returns a new instance of
jsx3.net.Service.css, jss, xml,
xsl, script (for JavaScript), services (for mapping rules),
or ljss.true, a JavaScript or CSS file is reloaded from the remote server
without checking the local browser cache. Other types of resources are not affected by this parameter.strType in not a valid type.
strType
parameter. See the method description. config.xml file of this application.loadInclude() for more information. setLocale() for the server to render properly in the new locale.jsx3.resolveURI(). In version 3.2, the URI is taken as relative to the application folder. In
particular, a relative URI will be resolved to a base of the application folder, an absolute URI will be
unaffected.getNode()
with no parameters. | Constructor Summary | |
|---|---|
| void | init(objXML : jsx3.xml.Document) The instance initializer. |
| Method Summary | |
|---|---|
| String | Number | boolean | Array | Object | Returns a stored setting value. |
| jsx3.xml.Entity | Returns a stored setting value as the raw XML node. |
| void | Removes a stored setting value. |
| void | Sets a stored setting value. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | |
| static int | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | clear() Clears all settings of this user settings instance. |
| String | Number | boolean | Array | Object | Returns a stored setting value. |
| void | Removes a stored setting value. |
| void | save() Persists the user settings. |
| void | Sets a stored setting value. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
PERSIST_INDEFINITE.
| Method Detail |
|---|
| Class Summary | |
|---|---|
| jsx3.chart.AreaChart | An area chart. |
| jsx3.chart.AreaSeries | A data series for an area chart. |
| jsx3.chart.Axis | A base class for all types of axis. |
| jsx3.chart.BCChart | Superclass of bar and column chart. |
| jsx3.chart.BCSeries | Shared functionality between BarSeries and ColumnSeries. |
| jsx3.chart.BarChart | A bar chart. |
| jsx3.chart.BarSeries | The data series type for a jsx3.chart.BarChart. |
| jsx3.chart.BubbleSeries | A data series used for a jsx3.chart.BubbleChart. |
| jsx3.chart.CartesianChart | Base chart class for charts that render on a cartesian plane with x and y axes. |
| jsx3.chart.CategoryAxis | Axis type that displays a set of discrete values (categories). |
| jsx3.chart.Chart | The base class for all charts in this package. |
| jsx3.chart.ChartComponent | A base class for every logical component of a chart. |
| jsx3.chart.ChartLabel | A chart component to render a text box. |
| jsx3.chart.ColumnChart | A column chart. |
| jsx3.chart.ColumnSeries | The data series type for a jsx3.chart.ColumnChart. |
| jsx3.chart.GridLines | A chart component that renders a grid of lines and fills aligned with an x and y axis. |
| jsx3.chart.Legend | Chart component that renders a simple legend. |
| jsx3.chart.LineChart | A line chart. |
| jsx3.chart.LineSeries | A data series for a line chart. |
| jsx3.chart.LinearAxis | Type of axis that displays a linear range of values. |
| jsx3.chart.LogarithmicAxis | An axis that displays a range of values logarithmically (base^n and base^(n+1) occupy same visual space). |
| jsx3.chart.PieChart | A pie chart. |
| jsx3.chart.PieSeries | A data series for a pie chart. |
| jsx3.chart.PlotChart | An plot (scatter/point/bubble) chart. |
| jsx3.chart.PlotSeries | Class encapsulating behavior shared by PointSeries and BubbleSeries
|
| jsx3.chart.PointRenderer | Objects that implement this interface may be used in Line/Area/Point/Bubble charts to render the points that appear
at each datapoint. |
| jsx3.chart.PointSeries | A data series used for a jsx3.chart.PointChart. |
| jsx3.chart.RadialChart | Base class for radial charts (pie chart is only example so far). |
| jsx3.chart.Series | The base class for all data series classes. |
| Field Summary | |
|---|---|
| static String | bottom/south quadrant |
| static String | left/west quadrant |
| static String | right/east quadrant |
| static String | top/north quadrant |
| Method Summary | |
|---|---|
| static jsx3.vector.Fill | Utility function, combines a vector fill and the property editor string format of a gradient |
| static Number | Utility function, converts a value to a Number |
| static boolean | isCategoryAxis(obj : Object) Tests whether an object is an Axis that displays set of discreet categories |
| static boolean | isValueAxis(obj : Object) Tests whether an object is an Axis that displays a range of number values |
| static Array | parseGradient(value : String) Utility function, parses the property editor string format of a gradient into its constituent parts |
| static Array | Splits a rectangular box in two pieces. |
| Field Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | getType() Returns the type field, corresponds to the variation of area chart, one of {'overlay','stacked','stacked100'}. |
| static String | Deprecated. |
| void | getXRange(series : ?) Returns the range of x values, used when x axis is value axis. |
| void | getYRange(series : ?) Returns the range of y values, considers chart type. |
| void | Sets the type field. |
| Methods Inherited From jsx3.chart.CartesianChart |
|---|
| getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis |
| Methods Inherited From jsx3.chart.Chart |
|---|
| getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | getForm() Returns the form field. |
| String | Returns the minField field. |
| Number | getMinValue(record : jsx3.xml.Entity) Returns the minimum y-coordinate of a data point in this series for the given record. |
| String | Returns the pointFill field. |
| String | Returns the pointGradient field. |
| int | Returns the pointRadius field. |
| jsx3.chart.PointRenderer | Returns the pointRenderer field. |
| String | Returns the pointStroke field. |
| static String | Deprecated. |
| String | Returns the xField field. |
| Number | getXValue(record : jsx3.xml.Entity) Returns the x-coordinate of a data point in this series for the given record. |
| String | Returns the yField field. |
| Number | getYValue(record : jsx3.xml.Entity) Returns the y-coordinate of a data point in this series for the given record. |
| void | Sets the form field, checks for valid value. |
| void | setMinField(minField : String) Sets the minField field. |
| void | setPointFill(pointFill : String) Sets the pointFill field, string representation of vector fill. |
| void | setPointGradient(pointGradient : String) Sets the pointGradient field, string representation of vector fill gradient. |
| void | setPointRadius(pointRadius : int) Sets the pointRadius field. |
| void | setPointRenderer(pointRenderer : String) Sets the pointRenderer field. |
| void | setPointStroke(pointStroke : String) Sets the pointStroke field, string representation of VectorStroke. |
| void | Sets the xField field. |
| void | Sets the yField field. |
| static String | The default tooltip function for this type of series. |
| Methods Inherited From jsx3.chart.Series |
|---|
| getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
horizontal x primary -> bottom vertical x primary -> left horizontal x secondary -> top vertical x secondary -> right
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the axisStroke field, string representation of the VectorStroke used to draw the line of the axis. |
| jsx3.chart.ChartLabel | Returns the optional jsx3.chart.ChartLabel child. |
| int | Returns the display width, the maximum amount of space perpendicular to the axis and outside of the data area that the ticks and labels may occupy (doesn't include area given to axis title). |
| boolean | Returns the horizontal field, whether this is an x axis, otherwise it is a y axis. |
| String | Returns the labelClass field, the CSS class used to render major tick labels. |
| String | Number | Returns the labelColor field, the RGB color value of the label font; note that this is the only way to set the color of the text, using a CSS style attribute will have no effect. |
| Function | Returns the labelFunction field. |
| int | Returns the labelGap field, the pixel gap between the tick lines and the labels. |
| String | Returns the labelStyle field, the CSS style attribute used to render major tick labels. |
| int | Returns the minorTickDivisions field, number of minor tick divisions between major ticks; the number of minor ticks drawn will be this number minus 1. |
| int | Returns the minorTickLength field, the length in pixels of the minor tick (if tickPlacement is "cross" the length will actually be twice this. |
| String | Returns the minorTickPlacement field, where to place the minor ticks. |
| String | Returns the minorTickStroke field, string representation of VectorStroke used to draw minor ticks. |
| jsx3.chart.Axis | Returns the opposing axis. |
| boolean | Returns the showAxis field, whether to show the line along the axis. |
| boolean | Returns the showLabels field, whether to show major tick labels. |
| int | Returns the tickLength field, the length in pixels of the major tick (if tickPlacement is "cross" the length will actually be twice this. |
| String | Returns the tickPlacement field, where to place the major ticks. |
| String | Returns the tickStroke field, string representation of VectorStroke used to draw major ticks. |
| static String | Deprecated. |
| static String | formats labels as a percent, ie "50%" |
| static String | formats labels in scientific notation, ie "5e2" |
| void | setAxisStroke(axisStroke : String) Sets the axisStroke field. |
| void | setDisplayWidth(displayWidth : int) Sets the displayWidth field. |
| void | setHorizontal(horizontal : boolean) Sets the horizontal field. |
| void | setLabelClass(labelClass : String) Sets the labelClass field. |
| void | setLabelColor(labelColor : String | Number) Sets the labelColor field. |
| void | setLabelFunction(labelFunction : String | Function) Sets the labelFunction field, allows for formatting and transformation of a major tick label. |
| void | setLabelGap(labelGap : int) Sets the labelGap field. |
| void | setLabelPlacement(labelPlacement : String) Sets the labelPlacement field, checks for invalid values. |
| void | setLabelStyle(labelStyle : String) Sets the labelStyle field. |
| void | setMinorTickDivisions(minorTickDivisions : int) Sets the minorTickDivisions field. |
| void | setMinorTickLength(minorTickLength : int) Sets the minorTickLength field. |
| void | setMinorTickPlacement(minorTickPlacement : String) Sets the minorTickPlacement field. |
| void | setMinorTickStroke(minorTickStroke : String) Sets the minorTickStroke field. |
| void | setShowAxis(showAxis : boolean) Sets the showAxis field. |
| void | setShowLabels(showLabels : boolean) Sets the showLabels field. |
| void | setTickLength(tickLength : int) Sets the tickLength field. |
| void | setTickPlacement(tickPlacement : String) Sets the tickPlacement field. |
| void | setTickStroke(tickStroke : String) Sets the tickStroke field. |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
function(value : Number|String) : String.
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| float | Returns the categoryCoverage field, the ratio of the range of a category that is covered by bars/columns. |
| float | Returns the seriesOverlap field, the ratio of a column width/row height that a column/row overlaps with the adjacent column/row. |
| String | getType() Returns the type field, corresponds to the variation of chart, one of {'clustered','stacked','stacked100'}. |
| static String | Deprecated. |
| void | setCategoryCoverage(categoryCoverage : float) Sets the categoryCoverage field. |
| void | setSeriesOverlap(seriesOverlap : float) Sets the seriesOverlap field. |
| void | Sets the type field. |
| Methods Inherited From jsx3.chart.CartesianChart |
|---|
| getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis, getXRange, getYRange |
| Methods Inherited From jsx3.chart.Chart |
|---|
| getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
BarSeries and ColumnSeries.
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the minField field. |
| Number | getMinValue(record : jsx3.xml.Entity) Returns the minimum value (x or y) of a data point in this series for the given record. |
| static String | Deprecated. |
| String | Returns the xField field. |
| Number | getXValue(record : jsx3.xml.Entity) Returns the x-coordinate of a data point in this series for the given record. |
| String | Returns the yField field. |
| Number | getYValue(record : jsx3.xml.Entity) Returns the y-coordinate of a data point in this series for the given record. |
| void | setMinField(minField : String) Sets the minField field. |
| void | Sets the xField field. |
| void | Sets the yField field. |
| Methods Inherited From jsx3.chart.Series |
|---|
| getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| Array<Number> | getXRange(series : ?) |
| Array<Number> | getYRange(series : ?) |
| Methods Inherited From jsx3.chart.BCChart |
|---|
| getCategoryCoverage, getSeriesOverlap, getType, setCategoryCoverage, setSeriesOverlap, setType |
| Methods Inherited From jsx3.chart.CartesianChart |
|---|
| getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis |
| Methods Inherited From jsx3.chart.Chart |
|---|
| getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| int | Returns the barHeight field. |
| void | setBarHeight(barHeight : int) Sets the barHeight field. |
| static String | The default tooltip function for this type of series. |
| Methods Inherited From jsx3.chart.BCSeries |
|---|
| getMinField, getMinValue, getXField, getXValue, getYField, getYValue, setMinField, setXField, setYField |
| Methods Inherited From jsx3.chart.Series |
|---|
| getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the magnitudeField field. |
| Number | getMagnitudeValue(record : jsx3.xml.Entity) Returns the magnitude of a data point in this series for the given record. |
| void | setMagnitudeField(magnitudeField : String) Sets the magnitudeField field. |
| static String | The default tooltip function for this type of series. |
| Methods Inherited From jsx3.chart.PlotSeries |
|---|
| getLegendRenderer, getRenderer, getXField, getXValue, getYField, getYValue, setRenderer, setXField, setYField |
| Methods Inherited From jsx3.chart.Series |
|---|
| getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| Array<jsx3.chart.GridLines> | Returns the array of children GridLines instances. |
| jsx3.chart.Axis | Returns the primary x axis, if any. |
| jsx3.chart.Axis | Returns the primary y axis, if any. |
| Array<Number> | getRangeForAxis(axis : jsx3.chart.Axis) Returns the range for axis, delegates to getXRange() or getYRange(). |
| static String | Deprecated. |
| abstract Array<Number> | getXRange(series : Array<jsx3.chart.Series>) Returns the range of x values in the data provider, subclasses must implement. |
| abstract Array<Number> | getYRange(series : Array<jsx3.chart.Series>) Returns the range of y values in the data provider, subclasses must implement. |
| Methods Inherited From jsx3.chart.Chart |
|---|
| getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the categoryField field, the attribute of records from the data provider that contains the category name (this value can still be transformed by Axis's 'labelFunction' field). |
| float | Returns the paddingHigh field, the number of category widths to pad the end of the axis with. |
| float | Returns the paddingLow field, the number of category widths to pad the beginning of the axis with. |
| String | Returns the tickAlignment field, if 'between' then the midpoint of the category is between two major ticks, otherwise if 'aligned' then the midpoint of the category is aligned with a major tick. |
| static String | Deprecated. |
| void | setCategoryField(categoryField : String) Sets the categoryField field. |
| void | setPaddingHigh(paddingHigh : float) Sets the paddingHigh field. |
| void | setPaddingLow(paddingLow : float) Sets the paddingLow field. |
| void | setTickAlignment(tickAlignment : String) Sets the tickAlignment field. |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static Array<jsx3.vector.Fill> | The default fill colors for series and categories whose fills are not specified. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| float | getAlpha() Returns the alpha field, the opacity to render the chart's background. |
| float | Returns the borderAlpha field, the opacity to render the chart's border. |
| String | Number | Returns the borderColor field, the RGB color to render the chart's border. |
| int | Returns the borderWidth field, the pixel width of the chart's border. |
| jsx3.chart.ChartLabel | Find the first jsx3.chart.ChartLabel child |
| String | Returns the dataPadding field, the CSS padding value that determines the padding around the data area, ie "10" or "5 0 5 0". |
| jsx3.chart.Legend | Find the first Legend child |
| int | in general the chart legend renders one entry for every series in the chart, override this method to show categories in the legend |
| String | Returns the legendPlacement field, the quadrant in which to place the legend. |
| Array<jsx3.chart.Series> | Returns the list of Series children. |
| int | Returns the index of a series in the list of series children. |
| String | Returns the titlePlacement field, the quadrant in which to place the title. |
| static String | Deprecated. |
| void | Note that this method is very expensive because it causes the entire chart to be redrawn. |
| void | Sets the alpha field. |
| void | setBorderAlpha(borderAlpha : float) Sets the borderAlpha field. |
| void | setBorderColor(borderColor : String | Number) Sets the borderColor field. |
| void | setBorderWidth(borderWidth : int) Sets the borderWidth field. |
| void | setDataPadding(dataPadding : String) Sets the dataPadding field. |
| void | setLegendPlacement(legendPlacement : String) Sets the legendPlacement field. |
| void | setTitlePlacement(titlePlacement : String) Sets the titlePlacement field. |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.chart.Legend.SHOW_SERIES
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| jsx3.chart.Chart | getChart() Returns the chart of which this component is a part. |
| static String | Deprecated. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | the default preferred width
|
| static int | angle for one-quarter counter-clockwise rotation |
| static int | angle for one-quarter clockwise rotation |
| static int | non-rotated angle |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| float | getAlpha() Returns the alpha field, the opacity of the background fill. |
| String | Returns the borderStroke field, string representation of the VectorStroke used to outline the background. |
| int | Returns the labelRotation field. |
| int | Returns the preferredHeight field. |
| int | Returns the preferredWidth field. |
| String | getText() Returns the text field. |
| static String | Deprecated. |
| boolean | whether this label is display at 90 or -90 degrees |
| void | Sets the alpha field. |
| void | setBorderStroke(borderStroke : String) Sets the borderStroke field. |
| void | setLabelRotation(labelRotation : int) Sets the labelRotation field. |
| void | setPreferredHeight(preferredHeight : int) Sets the preferredHeight field. |
| void | setPreferredWidth(preferredWidth : int) Sets the preferredWidth field. |
| void | Sets the text field. |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| Array<Number> | getXRange(series : ?) |
| Array<Number> | getYRange(series : ?) |
| Methods Inherited From jsx3.chart.BCChart |
|---|
| getCategoryCoverage, getSeriesOverlap, getType, setCategoryCoverage, setSeriesOverlap, setType |
| Methods Inherited From jsx3.chart.CartesianChart |
|---|
| getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis |
| Methods Inherited From jsx3.chart.Chart |
|---|
| getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| int | Returns the columnWidth field. |
| void | setColumnWidth(columnWidth : int) Sets the columnWidth field. |
| static String | The default tooltip function for this type of series. |
| Methods Inherited From jsx3.chart.BCSeries |
|---|
| getMinField, getMinValue, getXField, getXValue, getYField, getYValue, setMinField, setXField, setYField |
| Methods Inherited From jsx3.chart.Series |
|---|
| getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the borderStroke field, string representation of the stroke used to outline the grid lines. |
| Array<String> | getFillH() Returns the fillH field, array of string representations of vector fills used to fill in areas between horizontal major ticks; if the length of the array is greater than one, the areas alternate through the list of fills. |
| Array<String> | getFillV() Returns the fillV field, array of string representations of vector fills used to fill in areas between vertical major ticks; if the length of the array is greater than one, the areas alternate through the list of fills. |
| boolean | Returns the horizontalAbove field, whether to draw the horizontal lines and fills above the vertical ones. |
| boolean | Returns the inForeground field, whether to draw this legend on top of the data series (or below). |
| Array<String> | Returns the strokeMajorH field, array of string representations of VectorStroke's used to draw the horizontal major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes. |
| Array<String> | Returns the strokeMajorV field, array of string representations of VectorStroke's used to draw the vertical major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes. |
| Array<String> | Returns the strokeMinorH field, array of string representations of VectorStroke's used to draw the horizontal minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes. |
| Array<String> | Returns the strokeMinorV field, array of string representations of VectorStroke's used to draw the vertical minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes. |
| static String | Deprecated. |
| jsx3.chart.Axis | getXAxis() Returns the x (horizontal) axis used to determine where to draw tick lines. |
| jsx3.chart.Axis | getYAxis() Returns the y (vertical) axis used to determine where to draw tick lines. |
| void | setBorderStroke(borderStroke : String) Sets the borderStroke field. |
| void | Sets the fillH field. |
| void | Sets the fillV field. |
| void | setHorizontalAbove(horizontalAbove : boolean) Sets the horizontalAbove field. |
| void | setInForeground(inForeground : boolean) Sets the inForeground field. |
| void | setStrokeMajorH(strokeMajorH : Array<String>) Sets the strokeMajorH field. |
| void | setStrokeMajorV(strokeMajorV : Array<String>) Sets the strokeMajorV field. |
| void | setStrokeMinorH(strokeMinorH : Array<String>) Sets the strokeMinorH field. |
| void | setStrokeMinorV(strokeMinorV : Array<String>) Sets the strokeMinorV field. |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | the default height
|
| static int | the default width
|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the backgroundFill field, a string representation of the vector fill used to color in the background of the legend. |
| String | Returns the backgroundStroke field, a string representation of the VectorStroke used to outline the legend. |
| int | Returns the boxHeight field, the diameter of the box that shows the fill of each series or category. |
| String | Returns the labelClass field, the CSS class name applied to the name of each series or category. |
| String | Returns the labelStyle field, a CSS style attribute applied to the name of each series or category, ie "font-family: Arial; font-size: 10px;". |
| jsx3.chart.ChartLabel | Find the first jsx3.chart.ChartLabel child |
| int | Returns the lineHeight field, the vertical space taken for each legend entry. |
| int | Returns the preferredHeight field, the height that this component would like to have, though its true size is dictated by the container component. |
| int | Returns the preferredWidth field, the width that this component would like to have, though its true size is dictated by the container component. |
| static String | Deprecated. |
| void | setBackgroundFill(backgroundFill : String) Sets the backgroundFill field. |
| void | setBackgroundStroke(backgroundStroke : String) Sets the backgroundStroke field. |
| void | setBoxHeight(boxHeight : int) Sets the boxHeight field. |
| void | setLabelClass(labelClass : String) Sets the labelClass field. |
| void | setLabelStyle(labelStyle : String) Sets the labelStyle field. |
| void | setLineHeight(lineHeight : int) Sets the lineHeight field. |
| void | setPreferredHeight(preferredHeight : int) Sets the preferredHeight field. |
| void | setPreferredWidth(preferredWidth : int) Sets the preferredWidth field. |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | getType() Returns the type field, one of {'overlay','stacked','stacked100'}. |
| static String | Deprecated. |
| void | getXRange(series : ?) Returns the range of x values, used when x axis is value axis. |
| void | getYRange(series : ?) Returns the range of y values, considers chart type. |
| void | Sets the type field. |
| Methods Inherited From jsx3.chart.CartesianChart |
|---|
| getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis |
| Methods Inherited From jsx3.chart.Chart |
|---|
| getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | getForm() Returns the form field. |
| boolean | Returns the interpolateValues field. |
| String | Returns the pointFill field. |
| String | Returns the pointGradient field. |
| int | Returns the pointRadius field. |
| jsx3.chart.PointRenderer | Returns the pointRenderer field. |
| String | Returns the pointStroke field. |
| static String | Deprecated. |
| String | Returns the xField field. |
| String | Returns the yField field. |
| void | Sets the form field, checks for valid value. |
| void | setInterpolateValues(interpolateValues : boolean) Sets the interpolateValues field. |
| void | setPointFill(pointFill : String) Sets the pointFill field. |
| void | setPointGradient(pointGradient : String) Sets the pointGradient field. |
| void | setPointRadius(pointRadius : int) Sets the pointRadius field. |
| void | setPointRenderer(pointRenderer : String) Sets the pointRenderer field, should eval to an object that implements the renderer interface. |
| void | setPointStroke(pointStroke : String) Sets the pointStroke field. |
| void | Sets the xField field. |
| void | Sets the yField field. |
| static String | The default tooltip function for this type of series. |
| Methods Inherited From jsx3.chart.Series |
|---|
| getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | The maximum number of intervals to show when calculating by auto adjust. |
| static int | The minimum number of intervals to show when calculating by auto adjust. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| boolean | Returns the autoAdjust field, whether to adjust the max/min/interval to the range of the data. |
| boolean | Returns the baseAtZero field, whether to set either the min or max value of this axis to 0 if applicable and if autoAdjust is true. |
| int | getCoordinateFor(value : Number) convert a number value to a coordinate between 0 and this.length, if the value is outside of the range of the axis, return the closest value in the range |
| void | getCoordinateForNoClip(value : ?) same as getCoordinateFor(), but does not clip to bounds of the axis
|
| int | Returns the interval field, the interval between major ticks, overrides autoAdjust. |
| int | getMax() Returns the max field, the maximum value displayed by this axis, overrides autoAdjust. |
| int | getMin() Returns the min field, the minimum value displayed by this axis, overrides autoAdjust. |
| static String | Deprecated. |
| void | setAutoAdjust(autoAdjust : boolean) Sets the autoAdjust field. |
| void | setBaseAtZero(baseAtZero : boolean) Sets the baseAtZero field. |
| void | setInterval(interval : int) Sets the interval field. |
| void | Sets the max field. |
| void | Sets the min field. |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| boolean | Returns the autoAdjust field. |
| int | getBase() Returns the base field. |
| boolean | Returns the baseAtZero field, whether or not to set the minimum value to base^0, otherwise will choose an appropriate value for the data range. |
| int | getCoordinateFor(value : Number) convert a number value to a coordinate between 0 and this.length, if the value is outside of the range of the axis, return the closest value in the range |
| void | getCoordinateForNoClip(value : ?) same as getCoordinateFor(), but does not clip to bounds of the axis
|
| int | Returns the majorDivisions field, the number of major tick line divisions to place between the values base^n and base^(n+1). |
| int | Returns the maxExponent field, the range of values displayed will end at base^maxExponent. |
| int | Returns the minExponent field, the range of values displayed will begin at base^minExpronent. |
| boolean | Returns the showNegativeValues field. |
| static String | Deprecated. |
| void | setAutoAdjust(autoAdjust : boolean) Sets the autoAdjust field. |
| void | Sets the base field. |
| void | setBaseAtZero(baseAtZero : boolean) Sets the baseAtZero field. |
| void | setMajorDivisions(majorDivisions : int) Sets the majorDivisions field. |
| void | setMaxExponent(maxExponent : int) Sets the maxExponent field. |
| void | setMinExponent(minExponent : int) Sets the minExponent field. |
| void | setShowNegativeValues(showNegativeValues : boolean) Sets the showNegativeValues field. |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| static jsx3.vector.Fill | default coloring scheme for pie series, simply converts the default coloring scheme for series into a coloring scheme for categories |
| String | Returns the categoryField field, the attribute of a record that contains the category name value; necessary because there is no CategoryAxis to define this in a radial chart. |
| Function | Returns the colorFunction field, a function that defines how to color in the slices of each data series in this chart, with the signature function(record, index) : jsx3.vector.Fill; may be overridden by jsx3.chart.PieSeries.colorFunction for an individual series. |
| Array<String | int> | Returns the colors field, an array of string representations of a vector fill, to color in the slices of all the data series; may be overridden by jsx3.chart.PieSeries.colors for an individual series. |
| float | Returns the innerRadius field, the radius as the hole in the middle of the pie as a ratio of the entire radius. |
| float | Returns the seriesPadding field, the amount of padding between rings in a doughnut chart as a ratio of the width of a ring. |
| String | Returns the seriesStroke field, string representation of a VectorStroke to outline the slices of all the series with; may be overridden by jsx3.chart.PieSeries.stroke for an individual series. |
| int | Returns the startAngle field, the start angle of the first slice in each series; 0 points upwards and increasing values go clockwise; may be overridden on a series-by-series basis by jsx3.chart.PieSeries.startAngle. |
| int | Returns the totalAngle field, the total angle used for each series; may be overridden on a series-by-series basis by jsx3.chart.PieSeries.totalAngle. |
| static String | Deprecated. |
| void | setCategoryField(categoryField : String) Sets the categoryField field. |
| void | setColorFunction(colorFunction : String | Function) Sets the colorFunction field. |
| void | Sets the colors field. |
| void | setInnerRadius(innerRadius : float) Sets the innerRadius field. |
| void | setSeriesPadding(seriesPadding : float) Sets the seriesPadding field. |
| void | setSeriesStroke(seriesStroke : String) Sets the seriesStroke field. |
| void | setStartAngle(startAngle : int) Sets the startAngle field. |
| void | setTotalAngle(totalAngle : int) Sets the totalAngle field. |
| Methods Inherited From jsx3.chart.Chart |
|---|
| getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
function(record : jsx3.xml.Entity, index : Number) : jsx3.vector.Fill.
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| Array<String | int> | Returns the colors field, overrides per-chart setting in PieChart. |
| String | getField() Returns the field field, the attribute of the data provider to use as values for this series. |
| int | Returns the labelOffset field, the pixel offset of the optional ChartLabel child. |
| String | Returns the labelPlacement field, where to place the optional ChartLabel child. |
| int | Returns the startAngle field, overrides per-chart setting in PieChart. |
| int | Returns the totalAngle field, overrides per-chart setting in PieChart. |
| Number | getValue(record : jsx3.xml.Entity) Returns the value of a data point in this series for the given record. |
| static String | Deprecated. |
| void | Sets the colors field. |
| void | Sets the field field. |
| void | setLabelOffset(labelOffset : int) Sets the labelOffset field. |
| void | setLabelPlacement(labelPlacement : String) Sets the labelPlacement field. |
| void | setStartAngle(startAngle : int) Sets the startAngle field. |
| void | setTotalAngle(totalAngle : int) Sets the totalAngle field. |
| static String | The default tooltip function for this type of series. |
| Methods Inherited From jsx3.chart.Series |
|---|
| getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the magnitudeMethod field; the magnitude method defines how the magnitude value of a record in a bubble series is converted to a radius for the rendered point; a value of "radius" means that the magnitude will equal the radius of the point, "diameter" means that the magnitude will equal the diameter (2 * radius), and "area" means that the area of the point will be proportional to the magnitude. |
| int | Returns the maxPointRadius field, limit the radius of points on this chart to this value. |
| static String | Deprecated. |
| void | getXRange(series : ?) Returns the range of x values. |
| void | getYRange(series : ?) Returns the range of y values. |
| void | setMagnitudeMethod(magnitudeMethod : String) Sets the magnitudeMethod field, one of {"radius","diameter","area"}. |
| void | setMaxPointRadius(maxPointRadius : int) Sets the maxPointRadius field. |
| Methods Inherited From jsx3.chart.CartesianChart |
|---|
| getGridLines, getPrimaryXAxis, getPrimaryYAxis, getRangeForAxis |
| Methods Inherited From jsx3.chart.Chart |
|---|
| getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| jsx3.chart.PointRenderer | Returns the renderer used for the legend. |
| jsx3.chart.PointRenderer | Returns the renderer field. |
| static String | Deprecated. |
| String | Returns the xField field. |
| Number | getXValue(record : jsx3.xml.Entity) Returns the x-coordinate of a data point in this series for the given record. |
| String | Returns the yField field. |
| Number | getYValue(record : jsx3.xml.Entity) Returns the y-coordinate of a data point in this series for the given record. |
| void | setRenderer(renderer : String) Sets the renderer field. |
| void | Sets the xField field. |
| void | Sets the yField field. |
| Methods Inherited From jsx3.chart.Series |
|---|
| getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static jsx3.chart.PointRenderer | Creates a square point. |
| static jsx3.chart.PointRenderer | Creates a circular point. |
| static jsx3.chart.PointRenderer | Creates a x-shaped cross point. |
| static jsx3.chart.PointRenderer | Creates a diamond shaped point. |
| static jsx3.chart.PointRenderer | Creates an upward-pointing triangular point. |
| Method Summary | |
|---|---|
| abstract Number | areaToRadius(area : Number) Converts the area of the point to display to the radius of the box that it should fill. |
| abstract jsx3.vector.Tag | render(x1 : int, y1 : int, x2 : int, y2 : int, fill : jsx3.vector.Fill, stroke : jsx3.vector.Stroke) Renders the point in the bounds specified by {x1,y1} {x2,y2}. |
| Field Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| int | Returns the magnitude field, the magnitude value to use for each data point in this series. |
| void | setMagnitude(magnitude : int) Sets the magnitude field. |
| static String | The default tooltip function for this type of series. |
| Methods Inherited From jsx3.chart.PlotSeries |
|---|
| getLegendRenderer, getRenderer, getXField, getXValue, getYField, getYValue, setRenderer, setXField, setYField |
| Methods Inherited From jsx3.chart.Series |
|---|
| getColorFunction, getFill, getFillGradient, getIndex, getLabel, getSeriesName, getStroke, getTooltipFunction, getXAxis, getYAxis, setColorFunction, setFill, setFillGradient, setSeriesName, setStroke, setTooltipFunction |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| static Number | degreesToRadians(degrees : Number) Deprecated. Use jsx3.vector.degreesToRadians() instead.
|
| static String | Deprecated. |
| Methods Inherited From jsx3.chart.Chart |
|---|
| getAlpha, getBorderAlpha, getBorderColor, getBorderWidth, getChartTitle, getDataPadding, getLegend, getLegendEntryType, getLegendPlacement, getSeries, getSeriesIndex, getTitlePlacement, redrawRecord, setAlpha, setBorderAlpha, setBorderColor, setBorderWidth, setDataPadding, setLegendPlacement, setTitlePlacement |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.vector.Block |
|---|
| createCanvas, createVector, getCanvas, paintEventHandler, updateVector |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.vector.degreesToRadians() instead.
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| Function | Returns the colorFunction field. |
| String | getFill() Returns the fill field. |
| String | Returns the fillGradient field. |
| int | getIndex() Returns the index of this series in the list of chart's series. |
| jsx3.chart.ChartLabel | getLabel() Returns the optional jsx3.chart.ChartLabel child of this series. |
| String | Returns the seriesName field. |
| String | Returns the stroke field. |
| Function | Returns the function used to render tooltips for each area drawn by this series. |
| static String | Deprecated. |
| jsx3.chart.Axis | getXAxis() Returns the x axis that this series is plotted against. |
| jsx3.chart.Axis | getYAxis() Returns the y axis that this series is plotted against. |
| void | setColorFunction(colorFunction : String | Function) Sets the colorFunction field. |
| void | Sets the fill field, string representation of a vector fill. |
| void | setFillGradient(fillGradient : String) Sets the fillGradient field, string representation of a vector fill gradient. |
| void | setSeriesName(seriesName : String) Sets the seriesName field, this name is usually displayed in a legend or as a label. |
| void | Sets the stroke field, string representation of a VectorStroke. |
| void | setTooltipFunction(tooltipFunction : String | Function) Sets the function used to render tooltips for each area drawn by this series. |
| Methods Inherited From jsx3.chart.ChartComponent |
|---|
| getChart |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
function(record : jsx3.xml.Entity, index : Number) : jsx3.vector.Fill.function(s : jsx3.chart.Series, record : jsx3.xml.Entity) : String
| Class Summary | |
|---|---|
| jsx3.gui.Alerts | Mixin interface allows implementors to show alerts, confirms, and prompts. |
| jsx3.gui.Block | This class provides a container-based, object-oriented approach to creating static html objects (basically this class creates "DIV" objects). |
| jsx3.gui.BlockX | Paints the result of an XSL transformation in an Block. |
| jsx3.gui.Button | Provides a object-oriented interface for a standard command button. |
| jsx3.gui.CDF | Provides a container that maps to a CDF Document in the cache. |
| jsx3.gui.CheckBox | This class is a wrapper of the standard HTML checkbox. |
| jsx3.gui.ColorPicker | A GUI class that allows the user to pick a color using an HSB (hue-saturation-brightness) picker. |
| jsx3.gui.Column | Deprecated. Use jsx3.gui.Matrix.Column instead. |
| jsx3.gui.DatePicker | A form element that allows for the selection of an arbitrary date by showing a navigable calendar. |
| jsx3.gui.Dialog | Renders a dialog window. |
| jsx3.gui.DojoWidget | An adapter for Dojo widgets. |
| jsx3.gui.Event | Native browser event wrapper. |
| jsx3.gui.Form | Mixin interface. |
| jsx3.gui.Grid | Deprecated. Use jsx3.gui.Matrix instead. |
| jsx3.gui.Heavyweight | GUI utility class that provides a way to display HTML content on-screen in an HTML equivalent of a heavyweight container. |
| jsx3.gui.HotKey | Encapsulates a keydown event listener that is invoked by a certain combination of keys pressed simultaneously. |
| jsx3.gui.IFrame | Renders an IFrame. |
| jsx3.gui.Image | Renders an image. |
| jsx3.gui.ImageButton | An object-oriented interface onto a GUI button made of various image files. |
| jsx3.gui.Interactive | Mixin interface. |
| jsx3.gui.LayoutGrid | This class provides a way to organize a set of GUI objects in a grid. |
| jsx3.gui.List | Deprecated. Use jsx3.gui.Matrix instead. |
| jsx3.gui.Matrix | The Matrix control is the standard visual interface for the Common Data Format (CDF), providing grid and tree-grid functionality that mirrors the
the record and attribute structures used by the CDF. |
| jsx3.gui.Matrix.BlockMask | The interface that defines the methods that affect the behavior of a composite object used as an edit mask of a
matrix column. |
| jsx3.gui.Matrix.Column | Column control for use as a child of a jsx3.gui.Matrix class |
| jsx3.gui.Matrix.ColumnFormat | A class that defines the methods required for an object to be used by jsx3.gui.Matrix.Column instances to
format cells of data. |
| jsx3.gui.Matrix.EditMask | The interface defining the methods that affect the behavior of an object used as an edit mask in a matrix column. |
| jsx3.gui.Menu | Create GUI menus, similar in functionality to system menus (File, Edit, etc) created by the host OS. |
| jsx3.gui.NumberInput | A form element (text box) that stores a number value. |
| jsx3.gui.Painted | Abstract superclass of model objects that are painted to screen. |
| jsx3.gui.RadioButton | A GUI control that implements a single radio button. |
| jsx3.gui.Select | The JSX version of a standard GUI select box. |
| jsx3.gui.Slider | A GUI control that implements a draggable slider. |
| jsx3.gui.Sound | Class that provides an object-oriented interface for playing sounds in a GI application. |
| jsx3.gui.Splitter | This class manages layouts by providing a container that will paint its first two child GUI objects separated
by a 'splitter' (either vertical or horizontal). |
| jsx3.gui.Stack | This class is equivalent to a tab, but uses the stack metaphor; like a tab, it has one child—a block for its content; a jsx3.gui.Stack instance should only be contained by a jsx3.gui.StackGroup instance for proper rendering. |
| jsx3.gui.StackGroup | similar to how a tabbed pane manages a collection of tabs, the stack group is a parent container that manages JSXStack instances
|
| jsx3.gui.Tab | Renders a tab in a tabbed pane. |
| jsx3.gui.TabbedPane | Renders a tabbed pane, which consists of a set of tabs, only one of which is visible at a time. |
| jsx3.gui.Table | A lightweight control that displays CDF data in an HTML table. |
| jsx3.gui.Template | Provides template related services to the base template class, jsx3.gui.Template.Block. |
| jsx3.gui.Template.Block | Provides base class for creating custom GUI classes. |
| jsx3.gui.TextBox | This jsx3.gui.TextBox class allows integration of a standard HTML text input into the JSX DOM. |
| jsx3.gui.TimePicker | A form element that allows for the selection of an arbitrary time of day. |
| jsx3.gui.ToolbarButton | Renders a toolbar button. |
| jsx3.gui.Tree | Creates a DHTML-based navigational trees (similar to the tree structure used by Windows Explorer with folders
and files). |
| jsx3.gui.Window | Allows for rendering a branch of the DOM of an application in a separate browser window. |
| jsx3.gui.WindowBar | jsx3.gui.WindowBar instances are used as the captionbar for JSXDialog and JSXAlert instances. |
| Method Summary | |
|---|---|
| jsx3.gui.Dialog | alert(strTitle : String, strMessage : String, fctOnOk : Function, strOk : String, objParams : Object) Shows an alert dialog. |
| protected void | Configures the alert dialog. |
| jsx3.gui.Dialog | confirm(strTitle : String, strMessage : String, fctOnOk : Function, fctOnCancel : Function, strOk : String, strCancel : String, intBtnDefault : int, fctOnNo : Function, strNo : String, objParams : Object) Shows a confirm alert. |
| protected abstract jsx3.app.Model | implementors of this mixin interface must implement this method |
| jsx3.gui.Dialog | prompt(strTitle : String, strMessage : String, fctOnOk : Function, fctOnCancel : Function, strOk : String, strCancel : String, objParams : Object) Shows an input prompt alert. |
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | 0 |
| static String | center |
| static String | left (default) |
| static String | right |
| static String | jsx30block
|
| static String | #000000
|
| static String | Verdana
|
| static int | 10
|
| static String | span
|
| static String | |
| static String | [empty string] (default) |
| static String | none |
| static String | bold |
| static String | normal (default) |
| static int | Deprecated. |
| static int | 3 (default) |
| static int | 2 |
| static int | 1 |
| static int | 1 (default) |
| static int | Deprecated. |
| static String | JSX/images/spc.gif
|
| static String | hidden |
| static String | [empty string] (default) |
| Constructor Summary | |
|---|---|
| void | init(strName : String, vntLeft : int | String, vntTop : int | String, vntWidth : int | String, vntHeight : int | String, strHTML : String) instance initializer |
| Method Summary | |
|---|---|
| String | Returns valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat; |
| String | Returns valid CSS property value, (e.g. |
| String | Returns CSS property value(s) for a border (border: solid 1px #000000) |
| void | Returns the named attribute on the CDF record to which this object is mapped. |
| void | getCDFId() Returns the CDF ID of the record to map to. |
| String | Returns CSS text to override the standard instance properties on the painted object. |
| String | Returns the named CSS rule(s) to apply to the painted object. |
| String | getColor() Returns valid CSS property value, (e.g. |
| String | Returns valid CSS property value, (e.g. |
| Array<int> | Returns the dimensions in an array of four int values |
| String | Returns the CSS display for the object; one of jsx3.gui.Block.DISPLAYNONE (display:none;) and jsx3.gui.Block.DISPLAYBLOCK (display:;) |
| String | Returns the CSS font-family for the object |
| int | Returns the CSS font-size for the object |
| String | Returns the CSS font-weight for the object ("bold" or "normal") |
| int | String | Returns the height property of this object. |
| int | getIndex() Returns IE tab index for setting the tabIndex property for the on-screen DHTML for the object |
| static jsx3.gui.Block | getJSXParent(objGUI : HTMLElement) Deprecated. Use jsx3.html.getJSXParent() instead.
|
| int | String | getLeft() Returns the left property of this object. |
| String | Returns CSS property value(s) for a margin (margin:4px;) |
| int | Returns the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height |
| String | Returns CSS property value(s) for a padding (padding:4px;) |
| int | Returns if the instance is relatively positioned on-screen; returns one of: jsx3.gui.Block.ABSOLUTE jsx3.gui.Block.RELATIVE |
| String | Returns HTML tag name to use when rendering the object on-screen (span is the default); if the property is null,
jsx3.gui.Block.DEFAULTTAGNAME is used; |
| String | getText() Returns the text/HTML for the control to be displayed on-screen; returns an empty string if null; since the text
is rendered on-screen as browser-native HTML, the equivalent of an empty tag (e.g. |
| String | Returns the CSS text-align property for the object; if no property value exists, jsx3.gui.Block.ALIGNLEFT is returned by default |
| String | getTip() Returns the tooltip text to display when the object is hovered over. |
| int | String | getTop() Returns the top property of this object. |
| static String | Deprecated. |
| String | Returns the visibility property for the object |
| int | String | getWidth() Returns the width property of this object. |
| int | Returns the CSS z-index property |
| void | hideMask() Removes the "blocking" mask inside the block to stop user interactions with existing content
|
| String | Returns the DHTML, used for this object's on-screen view |
| jsx3.gui.Block | setBackground(strBG : String) Sets valid CSS property value for the background such as: background-image:url(x.gif); or background-image:url(x.gif);background-repeat:no-repeat;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets valid CSS property value, (e.g. |
| jsx3.gui.Block | Sets CSS property value(s) for a border (border: solid 1px #000000). |
| void | setCDFAttribute(strAttName : String) Sets the named attribute on the CDF record to which this object is mapped. |
| void | Sets the CDF ID of the record to map to. |
| jsx3.gui.Block | setCSSOverride(strCSS : String) Sets CSS text to override the standard instance properties on the painted object. |
| jsx3.gui.Block | setClassName(strClassName : String) Sets the named CSS rule(s) to apply to the painted object. |
| jsx3.gui.Block | Sets valid CSS property value, (e.g. |
| void | Sets valid CSS property value, (e.g. |
| void | setDimensions(left : int | String | Array<int | String>, top : int | String, width : int | String, height : int | String, bUpdateView : boolean) Set one to four dimensions at once. |
| jsx3.gui.Block | Sets the display for the object. |
| jsx3.gui.Block | setFontName(strFontName : String) Sets the CSS font-family for the object;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | setFontSize(intPixelSize : int) Sets the CSS font-size for the object;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | setFontWeight(FONTWEIGHT : String) Sets the CSS font-weight for the object ("bold" or "normal");
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the height property of this object. |
| jsx3.gui.Block | Sets IE tab index for setting the tabIndex property for the on-screen DHTML for the object;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the left property of this object. |
| jsx3.gui.Block | Sets CSS property value for margin. |
| jsx3.gui.Block | setOverflow(OVERFLOW : int) Sets the overflow property for the object, that defines how its on-screen view will behave when its contents are larger than its specified width and/or height;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the CSS property value for padding an object. |
| jsx3.gui.Block | Sets if the jsx3.gui.Block instance is relatively positioned on-screen;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | setTagName(strTagName : String) Sets HTML tag name to use when rendering the object on-screen (jsx3.gui.Block.DEFAULTTAGNAME is the default);
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the text/HTML for the control to be displayed on-screen;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | setTextAlign(ALIGN : String) Sets the CSS text-align property for the object;
returns reference to self to facilitate method chaining; |
| jsx3.gui.Block | Sets the tooltip text to display when the object is hovered over; updates the model and the view
immediately. |
| jsx3.gui.Block | Sets the top property of this object. |
| void | Sets the CSS visibility property the object |
| jsx3.gui.Block | Sets the width property of this object. |
| void | Sets the CSS z-index for the object |
| void | Displays a "blocking mask" inside the block to stop user interactions with content within the block. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.html.getJSXParent() instead.
true, the view of this object is immediately updated, obviating the need to call repaint().border: solid 1px #000000). Properties can be strung
together as in: border:solid 1px #989885;border-left-width:0px;
jsx3.gui.CDF will be used.
border-width, padding, margin, width, and height
are strongly discouraged, as they may interfere with the framework's internal box models.
Since some controls are composited from multiple HTML elements, some styles may not cascade to nested elements.
Instance Properties are the preferred method for applying styles.color:red;background-color:orange;border-width, padding, margin, width, and height are strongly discouraged.
Multiple rules may be specified, delimited with a space. For example, label emphasis.
Since some controls are composited from multiple HTML elements, some rule styles may not cascade to nested elements.
Dynamic Properties are the preferred method for applying global styles.true, the view of this object is immediately updated, obviating the need to call repaint().true, the view of this object is immediately updated, obviating the need to call repaint().
setLeft, setTop, etc. Any argument can be null to indicate not to update it.left is
an Array then this parameter is the second parameter passed to this method.
jsx3.gui.Block.DISPLAYNONE or jsx3.gui.Block.DISPLAYBLOCKtrue, the view of this object is immediately updated, obviating the need to call repaint().true, the view of this object is immediately updated, obviating the need to call repaint().true, the view of this object is immediately updated, obviating the need to call repaint().8 0 0 0. CSS syntax is
supported, but requires that pixels be designated. For example, using margin:5px;margin-left:10px;, is equivalent to
5 5 5 10.8 0 0 0. CSS syntax is
supported, but requires that pixels be designated. For example, using padding:5px;padding-left:10px;, is equivalent to
5 5 5 10.true, the view will be updated without requiring a repaint.true, the view of this object is immediately updated, obviating the need to call repaint().true, the view of this object is immediately updated, obviating the need to call repaint().SPYGLASS
event instead.true, the view of this object is immediately updated, obviating the need to call repaint().true, the view of this object is immediately updated, obviating the need to call repaint().
true, the view of this object is immediately updated, obviating the need to call repaint().true, the view of this object is immediately updated, obviating the need to call repaint().
| Constructor Summary | |
|---|---|
| void | init(strName : String, vntLeft : int | String, vntTop : int | String, vntWidth : int | String, vntHeight : int | String) instance initializer |
| Method Summary | |
|---|---|
| static String | Deprecated. |
| String | Returns the XSL string of this object. |
| String | Returns the XSL URL of this object. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.xml.Cacheable | setXSLString(strXSL : String) Sets the XSL string of this object. |
| jsx3.xml.Cacheable | Sets the XSL URL of this object. |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
EXECUTE – when the user clicks on the enabled button, when the button has focus and the user presses the
space or enter key, or when doExecute() is called on the button.MENU – on a mouseup event with the right button when the button has a bound context menu.| Field Summary | |
|---|---|
| static String | #e8e8f5
|
| static String | jsx30button
|
| static int | 18
|
| static String | #f6f6ff
|
| static String | #a6a6af
|
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| void | doClick() Deprecated. use doExecute() instead |
| void | doExecute(objEvent : jsx3.gui.Event) Invokes the EXECUTE model event of this button. |
| int | Sets the validation state for the button and returns the validation state; always returns jsx3.gui.Form.STATEVALID (as buttons can only be valid) |
| String | getValue() Because it implements the jsx3.gui.Form class, the jsx3.gui.Button class implements various form-related methods (validate, getValue, disable, etc); in the case of 'getValue', this method will return the button's text (caption) |
| static String | Deprecated. |
| String | paint() Returns the DHTML, used for this object's on-screen view. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState, setValue |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
doExecute() insteadEXECUTE model event of this button. Note that because the model event is invoked
programmatically rather than by user interaction the objEVENT event parameter will be
null if the objEvent parameter is undefined.objEVENT.
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| String | getCDFId() Returns the CDF ID of the record to map to. |
| void | Updates all mapped descendants with values from the source CDF Document |
| void | No-op. |
| void | Sets the CDF ID of the record to map to. |
| void | write() Updates the source CDF document with values returned from mapped descendants
|
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource, resetData |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
false no repaint will be applied when setting text or valuesjsxid attribute of the data record to redraw.INSERT, UPDATE, or DELETE.
jsx3.gui.CDF will be used.
TOGGLE – when the state of a checkbox changes through user interaction or when
setState() is called under the deprecated 3.0 model event protocol.MENU – on a mouseup event with the right button when the button has a bound context menu.| Field Summary | |
|---|---|
| static int | 1: checked |
| static String | jsx30checkbox
|
| static int | 2: dashed |
| static int | 0: unchecked (default) |
| Constructor Summary | |
|---|---|
| void | init(strName : String, vntLeft : int | String, vntTop : int | String, vntWidth : int | String, vntHeight : int | String, strText : String, CHECKED : int) The instance initializer. |
| Method Summary | |
|---|---|
| int | validates that the checkbox is checked if it is required (e.g. |
| int | Returns current state of checkbox; to get the state of the checkbox when it was first initialized, use: getDefaultChecked(). |
| int | Returns state of checkbox when it was first initialized; to get the current state, use: getChecked(); |
| int | getValue() Returns current state of checkbox; to get the state of the checkbox when it was first initialized, use: getDefaultChecked(). |
| static String | Deprecated. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.CheckBox | setChecked(intChecked : int) Sets the state of this checkbox. |
| jsx3.gui.CheckBox | setDefaultChecked(CHECKED : int) Sets state of checkbox when it is first initialized; returns reference to self |
| jsx3.gui.CheckBox | Sets the state of this checkbox. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
TOGGLE model event only under the
deprecated 3.0 model event protocol.CHECKED or UNCHECKED| Field Summary | |
|---|---|
| static int | Value for the axis property indicating a brightness axis. |
| static int | The default rendered height of this control if no height is specified. |
| static int | The default rendered width of this control if no width is specified. |
| static int | Value for the axis property indicating a hue axis. |
| static int | Value for the axis property indicating a saturation axis. |
| Constructor Summary | |
|---|---|
| void | init(strName : String, vntLeft : int | String, vntTop : int | String, vntWidth : int, vntHeight : int) The instance initializer. |
| Method Summary | |
|---|---|
| static Array<int> | Converts HSB color components to RGB components. |
| static Array<int> | Converts RGB color components to HSB components. |
| int | |
| int | getAxis() |
| int | getRGB() Returns the RGB value of the currently selected color as an integer. |
| int | getValue() Returns the RGB value of the currently selected color as an integer. |
| String | paint() Returns the HTML to render this control. |
| jsx3.gui.ColorPicker | Sets the color axis shown on the right side of the control. |
| void | Sets the currently selected color by HSB components. |
| void | Sets the currently selected color by RGB. |
| void | Sets the RGB value of this color picker. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
[r, g, b]. Each component is an integer [0, 255].
[0, 255]. If only one parameter is passed, this parameter
may be a 24-bit integer of the form 0xRRGGBB.[0, 255].[0, 255].[h, s, b]. Each component is a float [0.0, 1.0].
HUE, SATURATION, or BRIGHTNESS.
0xRRGGBB.0xRRGGBB.HUE, SATURATION, or BRIGHTNESS.[0.0, 1.0].[0.0, 1.0].[0.0, 1.0].
0xRRGGBB.
"#000000".
jsx3.gui.Matrix.Column instead.jsx3.gui.List instance (or compatible subclass).
It allows the developer to specify custom XSLT for more-complex output, custom edit masks for editable grids, sort
types and sort paths and other series-related activities.| Field Summary | |
|---|---|
| static String | jsx30column_c3
|
| static String | jsx30column_c1
|
| static int | 100
|
| static int | 0 |
| static int | 1 (default) |
| static void | Deprecated. Renamed to RESIZABLE.
|
| static String | number |
| static String | text (default) |
| static String | middle
|
| static String | top (default)
|
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| int | Returns whether the parent list/grid can be sorted on this column |
| String | Returns the data type for this column of data (affects sorting if this column is used for sorting the data); valid types include: jsx3.gui.Column.TYPETEXT and jsx3.gui.Column.TYPENUMBER |
| String | Returns name of JSX GUI object to use as the edit mask |
| String | getPath() Returns the selection path for this column of data. |
| int | Returns flag (jsx3.gui.Column.RESIZABLE or jsx3.gui.Column.FIXED) denoting whether or not the given column can be resized. |
| void | Deprecated. Renamed to getResizable. |
| String | Returns the selection path to use to sort this column. |
| String | Gets the vertical alignment for the header cell text. |
| static String | Deprecated. |
| int | getWrap() Gets whether or not the header cell for this column should wrap its text when the column is too narrow to display truncate with an ellipsis. |
| String | getXSLString(strXSL : ?) Returns XSLT fragment for any custom template to render the cells for this column. |
| String | Returns the DHTML, used for this object's on-screen VIEW |
| String | repaint() updates the on-screen VIEW for the object. |
| jsx3.gui.Column | setCanSort(SORT : int) Sets whether the parnet list/grid can be sorted on this column. |
| jsx3.gui.Column | setDataType(DATATYPE : String) Sets the data type for this column of data (affects sorting if this column is used for sorting the data); returns ref to self |
| jsx3.gui.Column | setEditMask(strJSXName : String) Sets name of JSX GUI object to use as the edit mask; can also can be the system-generated id assigned at object initialization; returns ref to self |
| jsx3.gui.Column | Sets the selection path for this column of data. |
| jsx3.gui.Column | setResizable(RESIZE : int) Sets flag (jsx3.gui.Column.RESIZABLE or jsx3.gui.Column.FIXED) denoting whether or not the given column can be resized. |
| void | Deprecated. Renamed to setResizable. |
| jsx3.gui.Column | setSortPath(strPath : String) Sets the selection path to use to sort this column. |
| jsx3.gui.Column | Sets the vertical alignment for the header cell text. |
| jsx3.gui.Column | Sets whether or not the header cell for this column should wrap its text when the column is too narrow to display truncate with an ellipsis. |
| jsx3.gui.Column | setXSLString(strXSL : String) binds an XSL document fragment (as string) as a property on the object, so that when the object is serialized
the XSL is contained within. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
this.getPath().jsx3.util.DateFormat class to both format and parse dates. Dates are formatted
before they are displayed in the text box of the date picker. Dates are parsed after a user manually changes the
text in the text box. Parsing with DateFormat is fairly strict. If parsing fails, the value of
the date picker is unchanged and the displayed value refreshes.
The calendar calculates dates in the time of the local machine, not UTC (Greenwich Mean Time). Date values chosen
with the calendar are always 0h:00m local time.
Date pickers publish the following model events:
CHANGE — when the value of the control is changed by the user selecting a date in the
calendar or editing the formatted date in the text box.SHOW — whenever the calendar is shown.HIDE — whenever the calendar is hidden.| Field Summary | |
|---|---|
| static String | Deprecated. This value is now localized.
|
| static int | Deprecated. This value is now localized.
|
| Constructor Summary | |
|---|---|
| void | init(strName : String, intLeft : int | String, intTop : int | String, intWidth : int | String, intHeight : int | String) The instance initializer. |
| Method Summary | |
|---|---|
| int | Returns STATEVALID if this date picker is not required or if it is required and its value is not
null, otherwise returns STATEINVALID. |
| void | Shows the calendar for this date picker and places focus within the calendar as though the user had clicked
on the show calendar button. |
| Date | getDate() Returns the current value of this form field as a JavaScript Date object. |
| int | Returns the jsxfirstweekday field |
| String | int | Returns the jsxformat field |
| String | Returns the URL to use for the clickable image that triggers the calendar to display. |
| String | getValue() Returns the value of this form field (the string displayed in the text box). |
| String | paint() |
| void | Set the date value of this form field |
| void | setFirstDayOfWeek(jsxfirstweekday : int) Sets the jsxfirstweekday field |
| void | Sets the format of this date picker. |
| void | Sets the URL to use for the clickable image that triggers the calendar to display. |
| jsx3.gui.DatePicker | Sets the value of this date picker. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
STATEVALID if this date picker is not required or if it is required and its value is not
null, otherwise returns STATEINVALID.Date object.jsx3.util.DateFormat.
The provided format may also be an integer, in which case it is intepreted as one of of the fields of
DateFormat - SHORT, MEDIUM, LONG, or FULL - and
the displayed format will be localized accordingly.jsx3.gui.WindowBar and one child of type jsx3.gui.Block.
| Field Summary | |
|---|---|
| static String | #e8e8f5 (default)
|
| static int | Enum value for the resizable property of instances of this class indicating a non-resizable dialog. |
| static int | Enum value for the windowState property of instances of this class indicating a maximized dialog. |
| static int | Enum value for the windowState property of instances of this class indicating a minimized dialog. |
| static int | Enum value for the modal property of instances of this class indicating a modal dialog. |
| static int | Enum value for the modal property of instances of this class indicating a non-modal dialog. |
| static int | Enum value for the resizable property of instances of this class indicating a resizable dialog. |
| static void | Deprecated. Renamed to RESIZABLE. |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| jsx3.gui.Dialog | beep() alerts the user's attention to the dialog box by making its caption bar 'flash' on-screen (as it typical with a windows modal dialog) |
| void | constrainPosition(arg : boolean | Array<int>) Modifies the top and left properties of this dialog in order to fit it within its parent container. |
| void | doClose() removes the dialog box from the JSX DOM and removes its on-screen VIEW from the browser DOM
|
| void | doMaximize(objTBB : jsx3.gui.ToolbarButton) Toggles the state of the dialog between 'maximized' and its 'initial state' |
| void | doToggleState(STATE : int) typically called by minimize/windowshade jsx3.gui.ToolbarButton in the dialog box's caption bar; toggles the window's state between full-size and window-shaded (where only the dialog's caption bar is visible); or fully minimized to the application task bar if one exists |
| void | Applies focus to the caption bar if the dialog has one; otherwise the dialog is given focus. |
| Object<String, int> | getAbsolutePosition(objRoot : HTMLElement) Returns the absolute positioning of the object's on-screen view (specifically, the dialog box, not its modal container if there is one) in relation to JSXROOT (whose left/top is 0/0). |
| jsx3.gui.Block | Implements necessary method for the Alerts interface. |
| String | Returns the outer border that surrounds the entire dialog. |
| int | Returns the uniform buffer that separates the dialog's content box, captionbar, and the outer dialog border. |
| jsx3.gui.WindowBar | Returns an object handle to the jsx3.gui.WindowBar instance associated with the jsx3.gui.Dialog instance |
| String | getContentBorder(strDefault : String) Returns the border that surrounds the dialog content. |
| int | getModal() Returns whether a dialog displays as modal or not. |
| int | Returns whether the dialog can be resized or not. |
| jsx3.gui.ToolbarButton | getTaskButton(objTaskBar : jsx3.gui.WindowBar) Returns object handle to the jsx3.gui.ToolbarButton instance that resides in the application (this.getServer()) task bar and is associated with this dialog instance; returns null if none found |
| static String | Deprecated. |
| int | Returns state of the window (full-size / window-shaded). |
| int | Returns numeric multiplier for the dialog's z-index. |
| boolean | isFront() Returns whether this dialog instance is the front-most dialog among all open dialogs |
| String | paint() Returns the HTML, used for this object's on-screen VIEW |
| void | Ensures that HTML content is added to the correct VIEW element given the unique complexities of a the jsx3.gui.Dialog class |
| void | Removes the box model abstraction for a given object and its descendants. |
| void | Sets the outer border that surrounds the entire dialog. |
| void | Sets the uniform buffer that separates the dialog's content box, captionbar, and the outer dialog border. |
| void | setContentBorder(strCSS : String) Sets the border that surrounds the dialog content. |
| jsx3.gui.Dialog | Sets whether a dialog displays as modal or not. |
| jsx3.gui.Dialog | Sets whether the dialog box's on-screen view can be resized; returns reference to self to facilitate method chaining |
| jsx3.gui.Dialog | setResizeParameters(RESIZE : int, intMinX : int, intMinY : int, intMaxX : int, intMaxY : int, strAfterResizeFunction : ?) Sets resize parameters such as min width, max width, etc for the dialog; returns reference to self to facilitate method chaining |
| jsx3.gui.Dialog | setWindowState(STATE : int) Sets state of the window (full-size / window-shaded); returns ref to self for method chaining |
| jsx3.gui.Dialog | setZMultiplier(intMultiplier : int) Sets numeric multiplier for the dialog's z-index. |
| Methods Inherited From jsx3.gui.Alerts |
|---|
| alert, configureAlert, confirm, prompt |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChildren, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
resizable property of instances of this class indicating a non-resizable dialog.windowState property of instances of this class indicating a maximized dialog.windowState property of instances of this class indicating a minimized dialog.modal property of instances of this class indicating a modal dialog.modal property of instances of this class indicating a non-modal dialog.resizable property of instances of this class indicating a resizable dialog.| Constructor Detail |
|---|
| Method Detail |
|---|
AFTER_MOVE
model event is specified, then this method is not called automatically and must be called explicitly by the
model event.true, this dialog will be placed entirely within its container,
with a certain amount of padding, and this dialog will be resized if necessary. If this argument is an array,
it is taken as the N-E-S-W minimum pixels to show after constraining the position of the dialog. A
null value for any dimension means that the entire dimension should be shown. A negative value
means the number of pixels less than the size of the dialog in that dimension.
Alerts interface.repaint to update the view.repaint to update the view.| Field Summary | |
|---|---|
| dijit._Widget | The native Dojo widget object. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | Gets or sets a property of the native Dojo object. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | The browser native event type beforeunload. |
| static String | The browser native event type blur. |
| static String | The browser native event type change. |
| static String | The browser native event type click. |
| static String | The browser native event type dblclick. |
| static String | The browser native event type error. |
| static String | The browser native event type focus. |
| static String | The browser native event type keydown. |
| static String | The browser native event type keypress. |
| static String | The browser native event type keyup. |
| static int | The browser native key code for the 0 key. |
| static int | The browser native key code for the 9 key. |
| static int | The browser native key code for the A key. |
| static int | The browser native key code for the Alt key. |
| static int | The browser native key code for the down arrow key. |
| static int | The browser native key code for the left arrow key. |
| static int | The browser native key code for the right arrow key. |
| static int | The browser native key code for the up arrow key. |
| static int | The browser native key code for the Backspace key. |
| static int | The browser native key code for the Ctrl key. |
| static int | The browser native key code for the Delete key. |
| static int | The browser native key code for the End key. |
| static int | The browser native key code for the Enter key. |
| static int | The browser native key code for the Esc key. |
| static int | The browser native key code for the F1 key. |
| static int | The browser native key code for the F15 key. |
| static int | The browser native key code for the Home key. |
| static int | The browser native key code for the Insert key. |
| static int | The browser native key code for the Meta key. |
| static int | The browser native key code for the number pad 0 key. |
| static int | The browser native key code for the number pad 9 key. |
| static int | The browser native key code for the number pad addition (+) key. |
| static int | The browser native key code for the number pad decimal (. |
| static int | The browser native key code for the number pad division (/) key. |
| static int | The browser native key code for the number pad multiply (*) key. |
| static int | The browser native key code for the number pad subtract (-) key. |
| static int | The browser native key code for the Page Down key. |
| static int | The browser native key code for the Page Up key. |
| static int | The browser native key code for the Shift key. |
| static int | The browser native key code for the space bar key. |
| static int | The browser native key code for the Tab key. |
| static int | The browser native key code for the Z key. |
| static String | The browser native event type load. |
| static String | The browser native event type mousedown. |
| static String | The browser native event type mousemove. |
| static String | The browser native event type mouseout. |
| static String | The browser native event type mouseover. |
| static String | The browser native event type mouseup. |
| static String | The browser native event type mousewheel. |
| static String | The browser native event type resize. |
| static String | The browser native event type unload. |
| Method Summary | |
|---|---|
| boolean | altKey() Returns true if the alt key was pressed. |
| boolean | Returns true if the backspace key was pressed. |
| int | button() Returns integer designating the mouse button clicked/moused-down/moused-up; 1 (left), 2 (right), and as supported. |
| void | Cancels event bubbling for the event. |
| void | Cancels the key from firing by setting the keyCode to 0 (zero) for the event. |
| void | Cancels the return value for the event. |
| int | clientX() Returns the clientX property for the event (where it occurred on-screen). |
| int | clientY() Returns the clientY property for the event (where it occurred on-screen). |
| boolean | ctrlKey() Returns true the ctrl key was pressed. |
| boolean | Returns true if the delete key was pressed. |
| boolean | Returns true if the down-arrow key was pressed. |
| boolean | endKey() Returns true if the end key was pressed. |
| boolean | enterKey() Returns true if the enter key was pressed. |
| boolean | Returns true if the escape key was pressed. |
| boolean | exists() Deprecated. |
| HTMLElement | Returns handle to the HTML element that was moused away from (onmouseout). |
| int | getTrueX() Returns the actual position in the browser from the left edge for where the event occurred. |
| int | getTrueY() Returns the actual position in the browser from the top edge for where the event occurred. |
| String | getType() Returns the type of event, e.g. |
| boolean | homeKey() Returns true if the home key was pressed. |
| boolean | Returns true if the insert key was pressed. |
| boolean | Whether one of the four arrow keys was pressed. |
| boolean | Whether one of the 15 function keys was pressed. |
| int | keyCode() Returns integer representing the key code of the key just pressed/keyed-down. |
| boolean | Returns true if the left-arrow key was pressed. |
| boolean | Returns true if the left-mouse-button was clicked. |
| boolean | Returns true if the page-down key was pressed. |
| boolean | Returns true if the page-up key was pressed. |
| boolean | Returns true if the right-arrow key was pressed |
| boolean | Returns true if the right-mouse-button was clicked. |
| void | Sets the the return value for the event. |
| boolean | shiftKey() Returns true if the shift key was pressed. |
| boolean | spaceKey() Returns true if the space bar was pressed. |
| HTMLElement | Returns handle to the HTML element acted upon (click, mousedown, etc). |
| static void | subscribe(strEventId : String, objHandler : Object | String | function, objFunction : function | String) Subscribes an event handler to events of type strEventId that bubble all the way up to the browser window. |
| boolean | tabKey() Returns true if the tab key was pressed. |
| HTMLElement | Returns handle to the HTML element that was moused over (onmouseover). |
| static void | Unsubscribes an event handler from events of type strEventId that bubble all the way up to the browser window. |
| static void | unsubscribeAll(strEventId : String) Unsubscribes all event handlers from a events of type strEventId that bubble all the way up to the browser window. |
| boolean | upArrow() Returns true if the up-arrow key was pressed. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
beforeunload.blur.change.click.dblclick.error.focus.keydown.keypress.keyup.load.mousedown.mousemove.mouseout.mouseover.mouseup.mousewheel.resize.unload.| Method Detail |
|---|
true if the alt key was pressed.true if the backspace key was pressed.true the ctrl key was pressed.true if the delete key was pressed.true if the down-arrow key was pressed.true if the end key was pressed.true if the enter key was pressed.true if the escape key was pressed.true if the native event object is present (if an event of any type actualy occurred).true if the home key was pressed.true if the insert key was pressed.true if the left-arrow key was pressed.true if the left-mouse-button was clicked.true if the page-down key was pressed.true if the page-up key was pressed.true if the right-mouse-button was clicked.true if the shift key was pressed.true if the space bar was pressed.strEventId that bubble all the way up to the browser window.jsx3.gui.Event.CLICK.true if the tab key was pressed.strEventId that bubble all the way up to the browser window.jsx3.gui.Event.CLICK.strEventId that bubble all the way up to the browser window. jsx3.gui.Event.CLICK.true if the up-arrow key was pressed.| Field Summary | |
|---|---|
| static String | #d8d8e5 (default)
|
| static String | #a8a8b5 (default)
|
| static int | Value for the required field indicating that the form field is optional. |
| static int | Value for the required field indicating that the form field is required. |
| static int | Value for the enabled field indicating that the form field is disabled. |
| static int | Value for the enabled field indicating that the form field is enabled. |
| static int | Value for the validation state field indicating that the value of the form field is invalid. |
| static int | Value for the validation state field indicating that the value of the form field is valid. |
| Method Summary | |
|---|---|
| jsx3.gui.HotKey | Binds the given key sequence to a callback function. |
| jsx3.gui.Form | doReset() Resets the validation state of this control. |
| abstract int | Abstract method that must be implemented by any class that implements the Form interface. |
| String | Returns the background color of this control when it is disabled. |
| String | Returns the font color to use when this control is disabled. |
| int | Returns the state for the form field control. |
| String | Returns the key binding that when keyed will fire the execute event for this control. |
| int | Returns whether or not this control is required. |
| int | Returns the validation state of this control. |
| Number | String | getValue() Returns the value of this control. |
| static String | Deprecated. |
| static void | reset(objJSXContainer : jsx3.app.Model) Traverses the DOM branch starting at objJSXContainer and calls doReset() on all nodes
of type jsx3.gui.Form. |
| jsx3.gui.Form | setDisabledBackgroundColor(strColor : String) Sets the background color of this form control when it is disabled. |
| jsx3.gui.Form | setDisabledColor(strColor : String) Sets the font color to use when this control is disabled. |
| void | Sets whether this control is enabled. |
| jsx3.gui.Form | setKeyBinding(strSequence : String) Sets the key binding that when keyed will fire the bound execute (jsx3.gui.Interactive.EXECUTE)
event for this control. |
| jsx3.gui.Form | setRequired(required : int) Sets whether or not this control is required. |
| jsx3.gui.Form | setValidationState(intState : int) Sets the validation state of this control. |
| jsx3.gui.Form | Sets the value of this control. |
| static int | Traverses the DOM branch starting at objJSXContainer and calls doValidate() on all nodes
of type jsx3.gui.Form. |
| Field Detail |
|---|
| Method Detail |
|---|
setKeyBinding()) will call this method when painted to register the key sequence with an appropriate
ancestor of this form control. Any key down event that bubbles up to the ancestor without being intercepted
and matches the given key sequence will invoke the given callback function.
As of 3.2: The hot key will be registered with the first ancestor found that is either a
jsx3.gui.Window, a jsx3.gui.Dialog, or the root block of a jsx3.app.Server.ctrl+s or
ctrl+shift+alt+h or shift+a, etc. Any combination of shift, ctrl, and alt are
supported, including none. Also supported as the final token are enter, esc,
tab, del, and space. To specify the final token as a key code, the
last token can be the key code contained in brackets, [13].null if strKeys is an invalid key
combination. STATEINVALID or STATEVALID.
STATEENABLED.STATEDISABLED or STATEENABLED. OPTIONAL.REQUIRED or OPTIONAL. STATEVALID.STATEINVALID or STATEVALID. objJSXContainer and calls doReset() on all nodes
of type jsx3.gui.Form.STATEDISABLED or STATEENABLED. null is
equivalent to STATEENABLED.true this control is immediately repainted to reflect the new setting.
jsx3.gui.Interactive.EXECUTE)
event for this control.REQUIRED or OPTIONAL.STATEINVALID or STATEVALID.objJSXContainer and calls doValidate() on all nodes
of type jsx3.gui.Form. A custom function handler, objHandler, can be passed that will
be called once for each encountered form control.STATEINVALID or STATEVALID.
jsx3.gui.Matrix instead.| Field Summary | |
|---|---|
| static String | background-image:url(JSX/images/list/grid.gif);
|
| static String | #c8cfd8
|
| static String | #c8cfd8
|
| static String | background-image:url(JSX/images/list/header.gif);
|
| static String | jsx30list_r2
|
| static String | |
| static String | url(JSX/images/grid/select.gif)
|
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| void | Deprecated. |
| int | validates the Grid; if the Grid is set to 'required', a selection must be made to pass validation. |
| String | Returns name of attribute that is mapped to the cell being edited (as defined by jsxpath property for the column containing the cell). |
| HTMLElement | Returns a handle to the active TD for the grid. |
| jsx3.app.Model | Returns a handle to the active Mask for the grid. |
| HTMLElement | Returns a handle to the active TR for the grid. |
| String | Returns CSS class to use for each repeating TR in the Grid. |
| String | Returns jsxid attribute for the CDF record selected in the view. |
| boolean | Returns whether the grid will listen (true) for the tab key and advance cursor focus to the next cell in the grid |
| static String | Deprecated. |
| jsx3.xml.Document | getXSL() Returns XSLT for the Grid, prioritizing the acquisition in the following order: 1) check cache; 2) check jsxxsl; 3) check jsxxslurl; 4) use default |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| void | reset the mask if necessary before repainting the given row |
| void | resetMask(objMask : jsx3.app.Model) takes the active mask and puts at 0,0; sets visibility to hidden |
| jsx3.gui.Grid | setTabListener(bBOOLEAN : boolean) ets whether the grid will listen (true) for the tab key and advance cursor focus to the next cell in the grid. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | 32000
|
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| static jsx3.gui.Heavyweight | Returns the instance of the heavyweight object with the given ID; to get the on-screen HTML instance call: jsx3.gui.Heavyweight.GO([id]).getRendered() |
| jsx3.gui.Heavyweight | adds a POSITION RULE ruleset (a simple structure/hash) to the array of position rules; Note that POSITION RULE objects are used by the show() method to determine the best possible location for a heavyweight item |
| jsx3.gui.Heavyweight | addXRule(objAnchor : Object | jsx3.gui.Event, strAnchorPoint : String, strPoint : String, intOff : int) adds a POSITION RULE ruleset (X value) (a simple structure/hash) to the array of position rules; Note that POSITION RULE objects are used by the show() method to determine the best possible location for a heavyweight item |
| jsx3.gui.Heavyweight | addYRule(objAnchor : Object | jsx3.gui.Event, strAnchorPoint : String, strPoint : String, intOff : int) adds a POSITION RULE ruleset (Y value) (a simple structure/hash) to the array of position rules; Note that POSITION RULE objects are used by the show() method to determine the best possible location for a heavyweight item |
| void | applyRatio(objGUI : ?) can be called if show() has been called; resets the ratio (width/total) of the VIEW to be that of [object].getRatio()
|
| void | can be called if show() has been called; allows an existing HW window to re-apply its rules (used for complex layouts requiring a multi-pass) |
| void | destroy() destroy's the on-screen VIEW for the HW container AND removes any reference to the instance from the hash; Destroy() affects the MODEL and the VIEW
|
| HTMLElement | Returns an object reference to the Browser Element parent to be used; if none specified, the browser BODY will be used |
| String | getHTML() Returns the HTML content to display inside the HW instance on-screen |
| int | Returns the CSS height property (in pixels); if this value is set, it is assumed that the Heavyweight container will not have its height lessened to fit on-screen. |
| String | getId() Returns the unique id for this heavyweight instance |
| String | Returns the overflow property for CONTENTS of the HW container; it is assumed that anytime a perfect fit cannot occur that the content will have its overflow property set to 'auto' unless specified otherwise |
| void | Returns a JavaScript object with properties: X,Y (Left and Top); relating to the 4 primary (N, S, E, W), 4 secondary (NE, SE, SW, NW), and origin (O) compass positions for O |
| String | Returns a POSITION RULE object at the given index; Note that POSITION RULE objects are JavaScript objects that implement the following 3 properties: _pixel (the on-screen point around which to pivot/place), _offset (amount to nudge the placement), _point (compass direction) |
| Object<String, Array> | Returns a JavaScript object array (hash). |
| Number | getRatio() |
| HTMLElement | getRendered(objGUI : jsx3.gui.Event | HTMLElement | HTMLDocument) Returns handle/reference to the Heavyweight Object's on-screen counterpart—basically a handle to a DHTML SPAN; |
| static String | Deprecated. |
| int | getWidth() Returns the CSS width property (in pixels); if this value is set, it is assumed that the Heavyweight container will not have its width lessened to fit on-screen. |
| int | Returns the z-index property; assumes jsx3.gui.Heavyweight.DEFAULTZINDEX if none supplied |
| void | hide() destorys the on-screen VIEW for the HW container; Hide() only affects the VIEW; this is not the same as setting visibility to "hidden", which doesn't actually destroy the VIEW
|
| jsx3.gui.Heavyweight | setDomParent(objGUI : HTMLElement) Sets an object reference to the Browser Element parent to be used; if none specified, the browser BODY will be used. |
| jsx3.gui.Heavyweight | Sets the HTML content to display inside the HW instance on-screen; returns ref to self |
| jsx3.gui.Heavyweight | Sets the CSS height property (in pixels); if this value is set, it is assumed that the Heavyweight container will not have its height lessened to fit on-screen. |
| jsx3.gui.Heavyweight | setOverflow(strOverflow : String) Sets the overflow property for CONTENTS of the HW container; it is assumed that anytime a perfect fit cannot occur that the content will have its overflow property set to 'auto' unless specified otherwise
returns reference to self to facilitate method chaining; |
| jsx3.gui.Heavyweight | Sets the desired ratio of the width to the height of this heavyweight. |
| jsx3.gui.Heavyweight | setVisibility(strVisibility : String) if the HW instance has an on-screen VIEW, this method can be used to toggle its visibility; it has no effect on the MODEL; it is most commonly used when "[object].show(false);" is called, allowing the developer to manually adjust layout before actually showing the HW instance. |
| void | Sets the CSS width property (in pixels); if this value is set, it is assumed that the Heavyweight container will not have its width lessened to fit on-screen. |
| void | Sets the CSS z-index for the object; if null, is passed, jsx3.gui.Heavyweight.DEFAULTZINDEX will be used as the default value |
| void | Sets the text/HTML for the control to be displayed on-screen; returns reference to self to facilitate method chaining; |
| String | toString() converts the object to a string representation more useful than the default implementation provided by the native JS engine |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static String | Event type published just after a hot key is invoked. |
| Method Summary | |
|---|---|
| void | destroy() Destroys this hot key. |
| int | Returns the keycode that this hot key responds to. |
| Object | Invokes this hot key by executing its callback function. |
| boolean | Returns whether this hot key had been destoyed. |
| boolean | Returns whether this hot key is enabled. |
| boolean | isMatch(objEvent : jsx3.gui.Event) Returns whether this hot key should be invoked for the keydown event objEvent. |
| static int | keyDownCharToCode(strChar : String) Converts the string representation of a keyboard key to an integer keycode. |
| void | setEnabled(bEnabled : boolean) Sets whether this hot key is enabled. |
| String | toString() |
| static jsx3.gui.HotKey | |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Method Detail |
|---|
WAS_INVOKED
event through the event dispatcher interface.objEvent.jsx3.gui.Event of type keydown.
The following string representations are supported:
A-Z, a-z, 0-9
";,./'[]\-=`"
F1-F15
enter, esc, tab, del, space,
backspace, up, down, left, right,
insert, home, end, pgup, pgdn.false to
this method.| Field Summary | |
|---|---|
| static int | |
| static int | |
| static int | |
| Method Summary | |
|---|---|
| HTMLDocument | Returns the native document object of this iframe. |
| HTMLElement | Returns the native iframe object of this iframe. |
| int | Returns the scroll mode of this iframe. |
| String | getSrc() Returns the URI of this iframe. |
| String | paint() Serializes this object to HTML. |
| jsx3.gui.IFrame | setScrolling(intScrolling : int) Sets the scroll mode of this iframe. |
| jsx3.gui.IFrame | Sets the URI of this iframe. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Method Detail |
|---|
null.null.SCROLLYES, SCROLLNO, or SCROLLAUTO.| Method Summary | |
|---|---|
| int | |
| int | |
| String | getSrc() Returns the URI of this image. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.Image | Sets the URI of this image. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | Value for the state field indicating that the toggle button is off. |
| static int | Value for the state field indicating that the toggle button is on. |
| static int | Value for the type field indicating a normal button. |
| static int | Value for the type field indicating a toggle (2-state) button. |
| Constructor Summary | |
|---|---|
| void | init(strName : String, vntLeft : int | String, vntTop : int | String, vntWidth : int, vntHeight : int) The instance initializer. |
| Method Summary | |
|---|---|
| int | If this image button is of type TYPE_TOGGLE, then the state must be either STATE_ON
or required must be OPTIONAL to pass validation. |
| String | Returns the URI of the disabled image of this image button. |
| String | Returns the URI of the down image of this image button. |
| String | getImage() Returns the URI of the image of this image button. |
| String | Returns the URI of the on image of this image button. |
| String | Returns the URI of the over image of this image button. |
| int | getState() Returns the current state of this image button. |
| int | getType() Returns the type of this image button. |
| boolean | Returns true if the images of this image button are pre-fetched. |
| String | paint() Paints this image button. |
| jsx3.gui.ImageButton | setDisabledImage(strImage : String) Sets the URI of the disabled image of this image button. |
| jsx3.gui.ImageButton | setDownImage(strImage : String) Sets the URI of the down image of this image button. |
| jsx3.gui.ImageButton | Sets the URI of the image of this image button. |
| jsx3.gui.ImageButton | setOnImage(strImage : String) Sets the URI of the on image of this image button. |
| jsx3.gui.ImageButton | setOverImage(strImage : String) Sets the URI of the over image of this image button. |
| jsx3.gui.ImageButton | setPreFetch(bFetch : boolean) Sets whether if the images of this image button are pre-fetched. |
| jsx3.gui.ImageButton | Sets the current state of this image button and updates the displayed image accordingly. |
| jsx3.gui.ImageButton | Sets the type of this image button. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, getValue, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState, setValue |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
TYPE_TOGGLE, then the state must be either STATE_ON
or required must be OPTIONAL to pass validation.true if the images of this image button are pre-fetched.TYPE_TOGGLE and its state is STATE_ON.STATE_OFF or STATE_ONTYPE_NORMAL or TYPE_TOGGLEjsx3.gui.Painted class and
implement the jsx3.util.EventDispatcher interface
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| Method Summary | |
|---|---|
| Object | Publishes a model event. |
| int | Returns whether is object supports programmatic drag, meanining it will allow any contained item to be
dragged and dropped on another container supporting drop. |
| int | Returns whether this object can be the target of a drop event. |
| int | Returns whether is object can be moved around the screen (this is not the same as drag/drop). |
| int | Returns whether is object can be spyglassed. |
| String | Returns the event script registered for the given event type. |
| Object<String, String> | Returns the associative array containing all the registered event script of this object. |
| String | getMenu() Returns the name of the jsx3.gui.Menu instance to display (as a context menu) when a user
clicks on this object with the right button. |
| static String | Deprecated. |
| String | Returns true if there is a event script registered for the given event type. |
| jsx3.gui.HotKey | registerHotKey(vntCallback : String | Function | jsx3.gui.HotKey, vntKey : int | String, bShift : boolean, bControl : boolean, bAlt : boolean) Registers a hot key with this JSX model node. |
| jsx3.gui.Interactive | removeEvent(strType : String) Removes an event script registered for the given model event type. |
| jsx3.gui.Interactive | Removes all events scripts registered with this object. |
| jsx3.gui.Interactive | setCanDrag(bDrag : int) Sets whether is object supports programmatic drag, meanining it will allow any contained item to be dragged/dropped. |
| jsx3.gui.Interactive | setCanDrop(bDrop : int) Sets whether this object can be the target of a drop event. |
| jsx3.gui.Interactive | setCanMove(bMovable : int) Sets whether is object can be moved around the screen (this is not the same as drag/drop). |
| jsx3.gui.Interactive | Sets whether is object can be spyglassed. |
| jsx3.gui.Interactive | Programmatically sets an event of this instance. |
| jsx3.gui.Interactive | Sets the name of the jsx3.gui.Menu instance to display when a user
clicks on this object with the right button. |
| void | setSpyStyles(strCSS : String) Sets the CSS definition to apply to an HTML element when a spyglass is shown for that element |
| void | called by 'window.setTimeout()' to display the spyglass hover for a given object; |
| Field Detail |
|---|
| Method Detail |
|---|
EventDispatcher interface. This method ensures that any
registered event script is executed in isolation to prevent most side effects.context
property of the event object that is published through the EventDispatcher interface.null if not event script is registered
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
setEvent() method or during component deserialization.jsx3.gui.Menu instance to display (as a context menu) when a user
clicks on this object with the right button.keydown events that bubble up to this object
will be checked against the hot key. If an event matches, the callback function will execute and the event
bubble will be canceled.
If the four parameters vntKey, bShift, bControl, and bAlt
match a previously registered hot key, the previous hot key is clobbered by the new one. Only one hot key callback
function (the most recently registered) will be executed by a single keydown event.false then this hot key will not cancel the
key event. This parameter can also be an instance of HotKey, in which case all
other parameters are ignored.HotKey.keyDownCharToCode()). If it is an integer, the hot key will match that
keycode value.null the shift key state of the keydown event must match this value
to invoke the hot key.null the control key state of the keydown event must match this value
to invoke the hot key.null the alt key state of the keydown event must match this value
to invoke the hot key.jsx3.Boolean.TRUE or jsx3.Boolean.FALSEjsx3.Boolean.TRUE or jsx3.Boolean.FALSEjsx3.Boolean.TRUE or jsx3.Boolean.FALSEjsx3.Boolean.TRUE or jsx3.Boolean.FALSEjsx3.util.EventDispatcher.subscribe() instead of this method. Whenever a model
event is published, it is published using the EventDispatcher interface as well as by executing
any registered event script.obj.setEvent("alert('hello.');", jsx3.gui.Interactive.EXECUTE);jsx3.gui.Menu instance to display when a user
clicks on this object with the right button. The name is a pointer by-name to a JSX object in the same server.jsx3.gui.Event instance to have the system automatically calculate the x/y position.intLeft also uses an integer. Otherwise, use null.
| Field Summary | |
|---|---|
| static int | Deprecated. |
| static int | Deprecated. |
| static Array<String> | Deprecated. |
| static int | Deprecated. |
| static int | Deprecated. |
| static int | Deprecated. |
| static int | Deprecated. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| int | Deprecated. |
| String | getCols() |
| Array<int | String> | Deprecated. Use getRows() and getCols() instead.
|
| int | Deprecated. Use getRows() and getCols() instead.
|
| int | Deprecated. |
| String | getRows() |
| static String | Deprecated. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.LayoutGrid | setBestGuess(LAYOUT : int) Deprecated. |
| jsx3.gui.LayoutGrid | |
| jsx3.gui.LayoutGrid | Deprecated. Use setRows() and setCols() instead.
|
| jsx3.gui.LayoutGrid | setOrientation(ORIENTATION : int) Deprecated. Use setRows() and setCols() instead.
|
| jsx3.gui.LayoutGrid | Deprecated. |
| jsx3.gui.LayoutGrid | |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
getRows() and getCols() instead.
getRows() and getCols() instead.
setRows() and setCols() instead.
setRows() and setCols() instead.
jsx3.gui.Matrix instead.| Field Summary | |
|---|---|
| static String | #F3F2F4
|
| static String | #c8cfd8
|
| static String | background-image:url(JSX/images/list/header.gif);
|
| static int | 20
|
| static String | jsx30list_r1
|
| static String | Deprecated. |
| static int | 1 |
| static int | 2 |
| static String | #2050df
|
| static String | url(JSX/images/list/select.gif)
|
| static int | 0 |
| static String | ascending |
| static String | descending |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| void | Appends a new row to the end of the list and adds a corresponding record to the CDF source XML. |
| jsx3.gui.List | clearXSL() Deprecated. use resetXslCacheData() instead. |
| jsx3.gui.List | Deselects all selected CDF records of this list. |
| jsx3.gui.List | deselectRecord(strRecordId : String) Deselects a CDF record of this list. |
| void | Deprecated. use setValue() or deselectAllRecords() instead. |
| void | Deprecated. use setValue() or deselectAllRecords() instead. |
| jsx3.gui.List | Deprecated. use setValue() or deselectRecord() instead. |
| void | Deprecated. use executeRecord() instead. |
| jsx3.gui.List | Deprecated. use setValue() or selectRecord() instead. |
| void | Sorts this list according to the current sort path. |
| int | validates the list; if the list is set to 'required', a selection must be made to pass validation. |
| void | executeRecord(strRecordId : String) Evaluates the JavaScript code in the jsxexecute attribute of one CDF record of this list. |
| jsx3.gui.List | focusRecord(strRecordId : String) Gives cursor focus to a row in the list. |
| HTMLElement | Returns a handle to the active TR for the list. |
| int | Deprecated. Replaced by getGrowBy which returns an integer argument rather than a boolean. |
| String | Returns the CSS color for the header row (for example, "#ffffff"). |
| String | Returns the CSS background property for the header row (for example, "background-image:url(abc.gif)"). |
| int | Returns whether the columns in the list can be re-ordered via user interaction. |
| void | Deprecated. Renamed to getResizable. |
| int | Returns whether the list will render with sortable columns. |
| int | Returns whether or not a new row will be appended to the VIEW when a new record is added to the CDF document for the List. |
| int | Returns the height of the header row in pixels. |
| int | Returns the selection type of this list. |
| int | Returns whether columns in this list can be resized. |
| void | Deprecated. Renamed to getResizable. |
| Array<String> | Returns the ids of the selected records of this list. |
| jsx3.util.List<jsx3.xml.Entity> | Returns the collection of selected records. |
| int | Returns the zero-based index of column to sort on. |
| String | Returns the direction (jsx3.gui.List.SORTASCENDING or jsx3.gui.List.SORTDESCENDING) for the sorted column; if no direction specified, ascending is returned |
| String | Returns the selection path for XSLT to use when sorting output. |
| String | Returns the data type to be used for sorting this list. |
| String | Array<String> | getValue() Returns the jsxid of the selected record if this list is a single-select list or an array of the the jsxids
of the selected records if this list is a multi-select list. |
| static String | Deprecated. |
| int | getWrap() Returns whether or not the rows in the grid will support text-wrapping and expand to display their wrapped
content OR be a fixed height. |
| jsx3.xml.Document | getXSL() Returns xslt for the List, prioritizing the acquisition in the following order: 1) check cache; 2) check jsxxsl; 3) check jsxxslurl; 4) use default |
| boolean | isSelected(strRecordId : String) Returns whether or not the given record is selected (true/false) |
| static void | onCheck(strId : String, strPropName : String, objGUI : HTMLElement, bToggle : boolean, objArray : Object) Deprecated. |
| static void | Static function that can be called from XSLT-generated content in a list cell to delete a row from the CDF of a
list instance. |
| static void | onRadio(strId : String, strPropName : String, objGUI : HTMLElement, bSelect : boolean, objArray : Object) provides function that can be called from XSLT-generated content in a list cell. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| void | List implementation. |
| void | Repaints the body portion of the list (the data rows), retaining the scroll position in the list whereas
repainting the entire list would reset scroll position. |
| void | Repaints the head portion of the list (the header row). |
| void | Reveals a record by scrolling any ancestor blocks as necessary. |
| jsx3.gui.List | selectRecord(strRecordId : String) Selects a CDF record of this list. |
| void | setAutoExpand(bExpand : int) Deprecated. Replaced by setGrowBy which takes an integer argument rather than a boolean one. |
| jsx3.gui.List | setBackgroundColorHead(strBGColor : String) Sets the CSS color for the header row (for example, #ffffff) |
| jsx3.gui.List | setBackgroundHead(strBG : String) Sets the CSS background property (can be a composite of varoius CSS-related bg properties) |
| jsx3.gui.List | setCanReorder(intReorder : int) Sets whether the columns in the list can be re-ordered via user interaction with the VIEW |
| void | Deprecated. Renamed to setResizable. |
| jsx3.gui.List | setCanSort(SORT : int) Sets whether the list will render with sortable columns. |
| jsx3.gui.List | Sets whether or not a new row will be appended to the VIEW when a new record is added to the CDF document for the List. |
| jsx3.gui.List | setHeaderHeight(intHeight : int) Sets the height of the header row in pixels. |
| jsx3.gui.List | setMultiSelect(intMulti : int) Sets the selection type of this list. |
| jsx3.gui.List | setResizable(BOOLEAN : int) Sets whether columns in this list can be resized. |
| void | Deprecated. Renamed to setResizable. |
| jsx3.gui.List | setSortColumn(intColumnIndex : int) Sets the zero-based index of column to sort on and executes the sort. |
| jsx3.gui.List | setSortDirection(intSortDir : String) Sets the direction (ascending or descending) for the sorted column. |
| jsx3.gui.List | setSortPath(strPath : String) Sets the index for the column that the data will be sorted on;
returns a ref to self; |
| jsx3.gui.List | setSortType(strDataType : String) Sets the data type for the list. |
| jsx3.gui.List | Sets the selected records for this list. |
| jsx3.gui.List | Sets whether or not the rows in the grid will support text-wrapping and expand to display their wrapped content
OR be a fixed height. |
| void | Updates the DHTML (VIEW) for an existing row within a list, circumventing a full table repaint by updating
the row directly. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
objMasterRecord parameter is null.jsxid.objMasterRecord.
If null, a unique, system-generated key will be used.
resetXslCacheData() instead.deselectAllRecords() instead.deselectAllRecords() instead.setValue() or deselectRecord() instead.SELECT and CHANGE model events only
under the deprecated 3.0 model event protocol.executeRecord() instead.strRecordId parameter. If this
parameter is omitted the code of any currently selected records is executed. Invokes the EXECUTE
model event only under the deprecated 3.0 model event protocol.setValue() or selectRecord() instead.SELECT and CHANGE model events only
under the deprecated 3.0 model event protocol.SORTASCENDING or SORTDESCENDING.jsxexecute attribute of one CDF record of this list.null if no row is active.
getGrowBy which returns an integer argument rather than a boolean.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE null)
the list will render with the default value of jsx3.gui.List.DEFAULTBACKGROUNDCOLORHEAD.null) the list will render with the default value of
jsx3.gui.List.DEFAULTBACKGROUNDHEAD.jsx3.Boolean.TRUE.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
null) the list will render with
the default value of jsx3.gui.List.DEFAULTHEADERHEIGHT.MULTI, SINGLE, or NOTSELECTABLE.
jsx3.Boolean.TRUE.jsx3.Boolean.TRUE or jsx3.Boolean.TRUE
setSortType() or the data type of the current sort.jsx3.gui.Column.TYPETEXT or jsx3.gui.Column.TYPENUMBER
jsx3.Boolean.TRUE.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsxid value for the record node (according to the CDF) to redrawjsx3.xml.CDF.INSERT, jsx3.xml.CDF.DELETE,
or jsx3.xml.CDF.UPDATE.
repaint()
must be called for the list to render properly.
setGrowBy which takes an integer argument rather than a boolean one.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.jsx3.Boolean.TRUE or jsx3.Boolean.FALSEMULTI, SINGLE, or NOTSELECTABLE.jsx3.Boolean.TRUE or jsx3.Boolean.TRUEAFTER_SORT only under the deprecated 3.0 model event protocol.jsx3.gui.Column.TYPETEXT or jsx3.gui.Column.TYPENUMBERstrRecordId parameter should be a single value for a single-select list
or a list of values for a multi-select list.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE| Nested Class Summary | |
|---|---|
| jsx3.gui.Matrix.BlockMask | The interface that defines the methods that affect the behavior of a composite object used as an edit mask of a
matrix column. |
| jsx3.gui.Matrix.Column | Column control for use as a child of a jsx3.gui.Matrix class |
| jsx3.gui.Matrix.ColumnFormat | A class that defines the methods required for an object to be used by jsx3.gui.Matrix.Column instances to
format cells of data. |
| jsx3.gui.Matrix.EditMask | The interface defining the methods that affect the behavior of an object used as an edit mask in a matrix column. |
| Field Summary | |
|---|---|
| static String | jsx:///images/matrix/append.gif
|
| static int | 2 |
| static int | 1 |
| static int | 0 |
| static int | 50
|
| static String | |
| static int | 20
|
| static String | Deprecated. This value is localized.
|
| static int | 18. |
| static int | 3. |
| static int | 250. |
| static int | 50. |
| static int | 20
|
| static String | Deprecated. Renamed to DEFAULTXSLURL.
|
| static String | font-weight:bold
|
| static String | jsx:///images/matrix/file.gif (default)
|
| static String | jsx:///images/matrix/minus.gif (default)
|
| static String | jsx:///images/matrix/plus.gif (default)
|
| static String | jsx:///images/matrix/insert_before.gif
|
| static String | 4. |
| static String | jsxpaintpage. |
| static int | The outer container is first painted and then the entirety of the data is painted during a second pass |
| static int | The outer container is first painted. |
| static int | Default. |
| static int | The outer container is first painted. |
| static int | The outer container is painted along with any rows which are immediate children of the rendering context and those
descendant rows that have an open path to the context node. |
| static String | jsx:///images/matrix/select.gif
|
| static int | 2 |
| static int | 1 (default) |
| static int | 0 |
| static String | ascending |
| static String | jsx:///images/matrix/sort_asc.gif (default)
|
| static String | descending |
| static String | jsx:///images/matrix/sort_desc.gif (default)
|
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| void | Instance override |
| void | Commits any active autorow session. |
| jsx3.xml.Entity | Removes a record from the XML data source of this object. |
| void | Deselects all selected CDF records. |
| void | deselectRecord(strRecordId : String) Deselects a CDF record within the Matrix. |
| void | Sorts according to the current sort path. |
| int |
STATEINVALID is returned if the required property of this control is
true and no selection is made. |
| void | executeRecord(strRecordId : String) Evaluates the JavaScript code in the jsxexecute attribute of one CDF record of this list. |
| void | Applies focus to the on-screen cell that corresponds to the intersection of the element in the CDF source
document identified by strCdfId, and the first column mapped to strAttName. |
| void | Applies focus to the on-screen cell that corresponds to the intersection of
the element in the CDF source document identified by strCdfId, and the cell at the given index. |
| void | focusRowById(strCdfId : String) Applies focus to the on-screen row that corresponds to the element in the CDF source document identified by
strCdfId. |
| int | Returns whether or not an 'auto append' row will be rendered, allowing the user to automatically add new rows to the instance. |
| Object | Returns an object array of name/value pairs representing the current auto row session. |
| String | Returns CSS property value(s) for a border (border: solid 1px #000000) |
| int | Returns whether the column children can be reordered via user interaction. |
| int | Returns whether the list will render with sortable columns. |
| HTMLElement | Returns the HTML element that represents the intersection of the row identified
by strCdfId and the first column mapped to the named CDF attribute, strAttName. |
| int | getFixedColumnIndex(strDefault : String) Returns the zero-based index of the on-screen column(s), to the left of which will be fixed and cannot be reordered. |
| String | getFocusStyle(strDefault : String) Returns the CSS string to apply to a Row/Cell when it has focus |
| String | Returns CSS property value(s) for a border (border: solid 1px #000000) |
| int | getHeaderHeight(strDefault : String) Returns the height of the header row in pixels. |
| String | Returns the icon to use for those CDF records that do not explicitly specify an icon via the jsximg attribute |
| String | getIconMinus(strDefault : String) Returns the icon to use when the given tree node is in an open state. |
| String | getIconPlus(strDefault : String) Returns the icon to use when the given tree node is in a closed state. |
| int | getPagingModel(strDefault : String) Returns how data should be painted on-screen. |
| int | getPanelPoolSize(strDefault : String) Returns the number panels (a panel contains a collection of rows--getRowsPerPanel()) that should be part of the pool. |
| int | getPanelQueueSize(strDefault : String) Sets the number of panels that are allowed in the queue waiting to be painted. |
| int | getReaperInterval(strDefault : String) Returns the the number of milliseconds to wait before checking for inactive panels to garbage collect. |
| int | getRenderNavigators(strDefault : String) Returns whether or not to render the navigation controls that are applied to the first column when rendering model is hierarchical. |
| String | getRenderingContext(strDefault : String) Returns the jsxid of the CDF record that will serve as the origin when rendering the data on-screen. |
| String | getRenderingModel(strDefault : String) Returns the rendering model (how rows will be painted on-screen). |
| int | Returns whether or not this column can be resized by the user. |
| int | getRowHeight(strDefault : String) Returns the row height |
| int | getRowsPerPanel(strDefault : String) Returns the number of rows each panel should contain. |
| int | Returns whether or not the column widths should be adjusted (decremented) such that all columns fit within the viewport. |
| int | getScrollInfoLabel(strDefault : String) Returns the info label to display when scrolling a paged instance, in order to show the scroll position. |
| int | Returns the horizontal scroll position of the list. |
| int | Returns the vertical scroll position. |
| Array<String> | Returns the jsxid(s) for the selected record(s). |
| jsx3.util.List<jsx3.xml.Entity> | Returns the collection of selected records. |
| String | getSelectionBG(strDefault : String) Returns the CSS string to apply to a Row/Cell when it has focus |
| int | getSelectionModel(strDefault : String) Returns the selection model. |
| String | Returns the direction (jsx3.gui.Matrix.SORT_ASCENDING or jsx3.gui.Matrix.SORT_DESCENDING) for the sorted column; if no direction specified, ascending is returned |
| String | Returns the name of the CDF attribute to sort on. |
| String | Returns the data type to be used for sorting this list. |
| Array | Returns an array of all jsxid attributes in the source CDF in the order they would appear if painted on-screen |
| int | getSuppressHScroller(strDefault : String) Returns whether or not to supress display of the horizontal scrollbar. |
| int | getSuppressVScroller(strDefault : String) Returns whether or not to supress display of the vertical scrollbar. |
| String | Array<String> | getValue() Returns an array of selected values (or empty array) if the selection model is jsx3.gui.Matrix.SELECTION_MULTI_ROW. |
| jsx3.xml.Document | getXSL() Deprecated. Per-instance control of the XSL template is deprecated
|
| void | Assigns objMoveChild as the previousSibling of objPrecedeChild |
| jsx3.xml.CDF | insertRecordProperty(strRecordId : String, strPropName : String, strPropValue : String, bRedraw : boolean) Inserts a new property into an existing record with jsxid equal to strRecordId. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| void | inserts DHTML (as string) into IE's on-screen DOM as a child of the object's on-screen VIEW |
| void | redrawCell(strRecordId : String, objColumn : jsx3.gui.Matrix.Column, bSuppressTriggers : boolean, objTRXML : jsx3.xml.Entity) Updates the on-screen cell to reflect the value in the CDF document to which the cell is mapped. |
| void | Updates the on-screen cell to reflect the value in the CDF document to which the cell is mapped. |
| void | Matrix implementation. |
| String | repaint() Updates the view of this object by calling paint() and replacing the current view with the
returned HTML. |
| void | Paints only the data rows. |
| void | Repaints the header row for improved runtime efficiency. |
| void | resetCacheData(objServer : jsx3.app.Server) Removes the XML source document stored under the XML ID of this object from the server cache. |
| void | resetFocusContext(strId : ?) Removes the focus style from whichever cell is designated to have focus context. |
| void | Ends any existing edit session and hides the active mask. |
| void | resetXmlCacheData(objServer : jsx3.app.Server) Removes the XML source document stored under the XML ID of this object from the server cache. |
| void | revealRecord(strRecordId : String) Reveals a record by toggling parent nodes open (if rendering hierarcally) and scrolling the record into view. |
| void | selectRecord(strRecordId : String) Selects a CDF record of this list. |
| void | setAutoRow(intBoolean : int) Sets whether or not an 'auto append' row will be rendered, allowing the user to automatically add new rows to the instance. |
| jsx3.gui.Block | Sets CSS property value(s) for a border (border: solid 1px #000000). |
| void | setCanReorder(REORDER : int) Sets whether the columns in the list can be re-ordered via user interaction with the VIEW |
| void | setCanSort(SORT : int) Sets whether the list will render with sortable columns. |
| void | setFixedColumnIndex(intIndex : int) Sets the zero-based index of the on-screen column(s), to the left of which will be fixed and cannot be reordered. |
| void | setFocusStyle(strCSS : String) Sets the CSS string to apply to a Row/Cell when it has focus. |
| void | setHeaderBorder(strCSS : String) Sets CSS property value(s) for a border on the header row (border: solid 1px #000000). |
| void | Sets the height of the header row in pixels. |
| void | Sets the icon to use for those CDF records that do not explicitly specify an icon via the jsximg attribute |
| void | setIconMinus(strURL : String) Sets the icon to use when the given tree node is in an open state. |
| void | setIconPlus(strURL : String) Sets the icon to use when the given tree node is in a closed state. |
| void | setPagingModel(intModel : int) Sets how data should be painted on-screen. |
| void | setPanelPoolSize(intCount : int) Sets the number panels (a panel contains a collection of rows--getRowsPerPanel()) that should be part of the pool. |
| void | setPanelQueueSize(intCount : int) Sets the number of panels that are allowed in the queue waiting to be painted. |
| void | setReaperInterval(intInterval : int) Sets the the number of milliseconds to wait before checking for inactive panels to garbage collect. |
| void | Sets whether or not to render the navigation controls on the first column when being rendered in hierarchical mode. |
| void | Sets the jsxid of the CDF record that will serve as the origin when rendering the data on-screen. |
| void | Sets the rendering model (how rows will be painted on-screen). |
| void | setResizable(RESIZE : int) Sets whether or not this column can be resized by the user. |
| void | Sets the on-screen row height. |
| void | Sets the number of rows each panel should contain. |
| void | setScaleWidth(intBoolean : int) Sets whether or not the column widths should be adjusted such that all columns visually display within the viewport. |
| void | setScrollInfoLabel(strLabel : String) Sets the standard info label to display when scrolling to show the scroll position. |
| void | setScrollLeft(intScrollLeft : int) Sets the horizontal scroll position. |
| void | Sets the vertical scroll position. |
| void | setSelectionBG(strURL : String) Sets the URL for the image to use (as the repeating background image) to denote selection. |
| void | setSelectionModel(intType : int) Sets the selection model |
| void | setSortDirection(intSortDir : String) Sets the direction (ascending or descending) for the sorted column. |
| void | setSortPath(strAttr : String) Sets the name of the CDF attribute to sort on. |
| void | setSortType(DATATYPE : String) Sets the data type for the list. |
| void | setSuppressHScroller(intTrueFalse : int) Sets whether or not to supress display of the horizontal scrollbar. |
| void | Sets whether or not to supress display of the vertical scrollbar. |
| jsx3.gui.Matrix | Sets the value of this matrix. |
| jsx3.xml.Cacheable | Sets the XML ID of this object. |
| jsx3.xml.Cacheable | setXMLString(strXML : String) Sets the XML string of this object. |
| jsx3.xml.Cacheable | Sets the XML URL of this object. |
| void | Updates the scroll height and scroll position of the vertical scrollbar. |
| void | Toggles the open/closed state for a node in the Matrix |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLTransformers, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, reloadFromSource |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChildren, recalcBox, removeAttribute, removeAttributes, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
jsx3.gui.Matrix.DEFAULT_PANEL_POOL_COUNT
DEFAULTXSLURL.
| Constructor Detail |
|---|
| Method Detail |
|---|
true or null, the object being adopted will be added to
the parent's view via the parent's paintChild() method.
This parameter is made available for those situations where a loop is executing and multiple
objects are being adopted. As view operations are the most CPU intensive, passing false
while looping through a collection of child objects to adopt will improve performance. After the
last child is adopted, simply call repaint() on the parent to immediately synchronize the view.onSetChild() and onSetParent() will still be called)jsxid attribute of the data record to remove.true or null, the on-screen view of this object is
immediately updated to reflect the deleted record.null if no such record found.
jsx3.gui.Matrix.SORT_ASCENDING or jsx3.gui.Matrix.SORT_DESCENDING.STATEINVALID is returned if the required property of this control is
true and no selection is made.jsx3.gui.Form.STATEINVALID or jsx3.gui.Form.STATEVALID.
jsxexecute attribute of one CDF record of this list.strCdfId, and the first column mapped to strAttName.jsxtext
strCdfId, and the cell at the given index.strCdfId. Note that since only cells can receive focus, this method will apply focus to the
first cell child in the row.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
null or jsx3.Boolean.TRUE, the instance is sortable.strCdfId and the first column mapped to the named CDF attribute, strAttName.jsxtext1, the first column can never be reordered and will always remain the first column. If this value is set to 2,
the first two columns will be fixed. Setting this value to 0 is effectively the same as setting it to null
null), the list will render with
the default value of jsx3.gui.Matrix.DEFAULT_HEADER_HEIGHT.jsx3.gui.Matrix.ICON will be applied when rendered.
jsx3.gui.Matrix.ICON_MINUS will be applied when rendered.
jsx3.gui.Matrix.ICON_PLUS will be applied when rendered.
jsx3.gui.Matrix.PAGING_OFF will be applied. Note that the rendering model limits the available paging models:
getRowsPerPanel()) that should be part of the pool. If a panel count greater
than this value exists, the panels furthest away (as calculated by the scroll position) from the active panel will be destroyed. If this value is null,
the value defined by the constant, jsx3.gui.Matrix.DEFAULT_PANEL_POOL_COUNT, will be used.jsx3.gui.Matrix.DEFAULT_PANEL_QUEUE_SIZE
Note that this is different from the number of painted panels allowed on screen (e.g., getPanelPoolSize()).jsx3.gui.Matrix.DEFAULT_REAPER_INTERVAL
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.gui.Matrix.DEFAULT_ROWS_PER_PANEL
null or jsx3.Boolean.FALSE, scale width will not be used and the column widths will render
fully, displaying a horizontal scrollbar when necessary. In such a case, all wildcard columns (e.g., *) will be resolved to the value,
jsx3.gui.Matrix.Column.DEFAULT_WIDTH.this.getValue() except that the return value is always an Array.jsx3.gui.Matrix.SELECTION_ROW)setSortType() or the data type of the current sort.jsx3.gui.Matrix.Column.TYPE_TEXT or jsx3.gui.Matrix.Column.TYPE_NUMBER
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.gui.Matrix.SELECTION_MULTI_ROW. Returns a string (or null)
for the other selection modelsfalse the repaint will be suppressed
jsxid equal to strRecordId.
If the property already exists, the existing property value will be updated. If no such record exists
in the XML document, this method fails quietly.jsxid attribute of the data record to modify.true or null, the on-screen view of this object is
immediately updated to reflect the inserted property.jsxid value for the record node (according to the CDF) corresponding to the on-screen row to update[objColumn].getPath()) as well as all sibling Columns that are triggered by the named attribute
(e.g., [objColumn].getTriggers()) will also be redrawn.jsxid value for the record node (according to the CDF) corresponding to the on-screen row to update[objColumn].getPath()) as well as all Column children that are triggered by the named attribute
(e.g., [objColumn].getTriggers()) will be redrawn.jsxid value for the record node (according to the CDF) to redrawjsx3.xml.CDF.INSERT, jsx3.xml.CDF.INSERTBEFORE, jsx3.xml.CDF.DELETE, or jsx3.xml.CDF.UPDATE.paint() and replacing the current view with the
returned HTML. This method has no effect if this object is not currently displayed.paint() or null if this object is not displayed. this.getServer() does not returns a server instance.
this.getServer() does not returns a server instance.
jsx3.gui.Matrix.PAGING_PAGED, the auto row
feature is disabled. The CSS style for the auto row (a TR element) can be modified via the XSL Parameters palette, via the XSL
parameter, jsx_autorow_style
border: solid 1px #000000). Updates MODEL and VIEW (unless repaint is suppressed).true to stop the default repaint from occurring.
Typically property updates that affect the browser-specific box model (such as borders) are repainted
immediately to keep the box model abstraction in synch with the native view. However, the repaint can be
suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
border: solid 1px #000000). Updates both model and view.true to stop the default repaint from occurring.
Typically property updates that affect the browser-specific box model (such as height) are repainted
immediately to keep the box model abstraction in sync with the native view. However, the repaint can be
suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.
jsx3.gui.Matrix.PAGING_OFF will be applied.getRowsPerPanel()) that should be part of the pool.jsx3.Boolean.TRUE or jsx3.Boolean.FALSEtrue to stop the default repaint from occurring.
Typically property updates that affect the browser-specific box model (such as rendering the navigational controls) are repainted
immediately to keep the box model abstraction in synch with the native view. However, the repaint can be
suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.
true to stop the default repaint from occurring.
true to stop the default repaint from occurring.
jsx3.gui.Matrix.DEFAULT_ROW_HEIGHT).
If row height is 0, the row height is flexible and the row's height will expand to fit the content.true to stop the default repaint from occurring.
Typically property updates that affect the browser-specific box model (such as padding) are repainted
immediately to keep the box model abstraction in synch with the native view. However, the repaint can be
suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.
true to stop the default repaint from occurring.
jsx3.Boolean.FALSE if not set, meaning a horizontal scrollbar will appear if the aggregate column widths
exceed the available width of the viewport.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.Boolean.TRUE or jsx3.Boolean.FALSEtrue to stop the default repaint from occurring.
Typically property updates that affect the browser-specific box model (such as rendering the vertical scrollbar) are repainted
immediately to keep the box model abstraction in synch with the native view. However, the repaint can be
suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.
null or a well-formed serialized XML element.null or a URI that when resolved against the server owning this object
specifies a valid XML document.jsx3.gui.Block but does not implement
jsx3.gui.Form will have these methods inserted into it. Such an object only has to define the methods
whose default behavior it wishes to override.| Method Summary | |
|---|---|
| void | emBeginEdit(strValue : ?, objTdDim : ?, objPaneDim : ?, objMatrix : ?, objColumn : ?, strRecordId : ?, objTD : ?) |
| void | |
| void | |
| void | emInit(objColumn : ?) |
| jsx3.gui.Painted | Returns the DOM node that should be focused when the edit session begins. |
| String | Returns the value currently stored in this edit mask. |
| void | setMaskValue(strValue : String) Sets the value currently stored in this edit mask. |
| Methods Inherited From jsx3.gui.Matrix.EditMask |
|---|
| commitEditMask, emGetSession, resumeEditSession, suspendEditSession |
| Method Detail |
|---|
jsx3.gui.Form.jsx3.gui.Form.jsx3.gui.Form.| Field Summary | |
|---|---|
| static String | top |
| static int | 100
|
| static String | number |
| static String | text (default) |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| jsx3.Boolean | Returns whether the parent list/grid can be sorted on this column. |
| String | Returns CSS property value for the data cell background-color. |
| String | Returns CSS property value for the data cell border. |
| String | Returns CSS property value for the data cell color. |
| String | Returns CSS property value for the data cell cursor. |
| String | Returns the CSS property value for the data cell font-family. |
| int | Returns the CSS property value for the data cell font-size. |
| String | Returns the CSS property value for the data cell font-weight. |
| String | Returns the CSS property value for the data cell padding. |
| String | Returns the CSS property value for the data cell text-align. |
| String | Returns the CSS property value for the data cell vertical-align. |
| int | getCellWrap(strDefault : String) Returns whether or not the data cellc will support text-wrapping. |
| String | Returns the data type for this column of data (affects sorting if this column is used for sorting the data); valid types include: jsx3.gui.Matrix.Column.TYPE_TEXT and jsx3.gui.Matrix.Column.TYPE_NUMBER |
| int | Returns the zero-based index for ths column in relation to its siblings. |
| String | Gets the named object that will handle the reformatting of a given column's data cells. |
| String | getPath() Returns the selection path for this column of data. |
| jsx3.Boolean | Gets whether or not this column can be resized by the user. |
| String | Returns the data type for this column of data (affects sorting if this column is used for sorting the data). |
| String | Returns the CDF attribute to use to sort on this column. |
| String | Returns one or more named attributes. |
| String | Returns the CSS property value for the header cell vertical-align. |
| String | getValueTemplate(strDefault : String) Gets the user-defined XSL template (xsl:template) that will override the defualt template defined by Column.TEMPLATES.default. |
| jsx3.Boolean | Gets whether or not the header cell will support text-wrapping. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| String | repaint() Updates the view of this object by calling paint() and replacing the current view with the
returned HTML. |
| void | Sets property value(s) for a border for the header cell (solid 1px #000000). |
| void | setCanSort(SORT : jsx3.Boolean) Sets whether the parnet list/grid can be sorted on this column. |
| void | setCellBackgroundColor(strColor : String) Sets CSS property value for the data cell background-color. |
| void | Sets CSS property value(s) for a border for the data cells. |
| void | setCellColor(strColor : String) Sets CSS property value for the data cell color. |
| void | setCellCursor(strCursor : String) Sets CSS property value for the data cell cursor. |
| void | setCellFontName(strFontName : String) Sets the CSS property value for the data cell font-family. |
| void | setCellFontSize(intPixelSize : int) Sets the CSS property value for the data cell font-size. |
| void | setCellFontWeight(FONTWEIGHT : String) Sets the CSS property value for the data cell font-weight. |
| void | Sets the CSS property value for the data cell padding. |
| void | setCellTextAlign(ALIGN : String) Sets the CSS property value for the data cell text-align. |
| void | setCellVAlign(VALIGN : String) Sets the CSS property value for the data cell vertical-align. |
| void | setCellWrap(WRAP : int) Sets whether or not the data cellc will support text-wrapping. |
| void | setDataType(DATATYPE : String) Sets the data type for this column of data (affects sorting if this column is used for sorting the data); returns ref to self |
| jsx3.gui.Matrix.Column | Sets the display for the object. |
| void | setFormatHandler(handler : String | Function | jsx3.gui.Matrix.ColumnFormat) Sets the identifier for which of the default column formatters should be implemented. |
| void | setPadding(strCSS : String) Sets CSS property value(s) for a padding for the header cell. |
| void | Sets the selection path for this column of data. |
| void | setResizable(RESIZE : jsx3.Boolean) Sets whether or not this column can be resized by the user. |
| void | setSortDataType(DATATYPE : String) Sets the data type for this column of data (affects sorting if this column is used for sorting the data); returns ref to self |
| void | setSortPath(strPath : String) Sets the CDF attribute to use to sort on this column. |
| jsx3.gui.Matrix.Column | Sets the text/HTML for the control to be displayed on-screen. |
| void | setTriggers(strTriggers : String) Sets one or more named attributes. |
| void | Sets the CSS property value for the header cell vertical-align. |
| void | setValueTemplate(TEMPLATE : String) Sets the user-defined XSL template (xsl:template) that will override the defualt template defined by Column.DEFAULT_VALUE_TEMPLATE. |
| jsx3.gui.Matrix.Column | Sets the Width on the column. |
| void | setWrap(WRAP : jsx3.Boolean) Sets whether or not the header cell will support text-wrapping. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.gui.Matrix.ColumnFormat, or adhere to its APIs.
Can also return the function literalthis.getPath(). The data source of the matrix containing this column is
sorted on this attribute when the matrix is sorted on this column.Column.TEMPLATES.default.paint() and replacing the current view with the
returned HTML. This method has no effect if this object is not currently displayed.paint() or null if this object is not displayed. solid 1px #000000). Updates are applied immediatelyrepaint on the parent instance to update the view.solid 1px red;solid 0px;solid 0px;solid 1px whitetrue to stop the default repaint from occurring.
Typically property updates that affect the browser-specific box model (such as borders) are repainted
immediately to keep the box model abstraction in synch with the native view. However, the repaint can be
suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.
repaint on the parent instance to update the view.repaint on the parent instance to update the view.repaint on the parent instance to update the view.repaint on the parent instance to update the view.repaint on the parent instance to update the view.jsx3.gui.Block.FONTBOLD, jsx3.gui.Block.FONTNORMAL
8 4 8 4true to stop the default repaint from occurring.
Typically property updates that affect the browser-specific box model (such as padding) are repainted
immediately to keep the box model abstraction in synch with the native view. However, the repaint can be
suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.
repaint on the parent instance to update the view.jsx3.gui.Block.ALIGNLEFT, jsx3.gui.Block.ALIGNRIGHT, jsx3.gui.Block.ALIGNCENTER
repaint on the parent instance to update the view.repaint to update the VIEWjsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.gui.Block.DISPLAYNONE and jsx3.gui.Block.DISPLAYBLOCKtrue, the view of this object is immediately updated.@unescape.
- or -
Function literal with the signature,function(element,cdfkey, matrix, column, rownumber,server). For example:
function(element, cdfkey, matrix, column, rownumber, server) {
var mf = new jsx3.util.MessageFormat("{0,number,currency}");
element.innerHTML = mf.format(element.innerHTML);
};
8 4 8 4
jsxtexttrue to stop the default repaint from occurring.
Typically property updates that affect the XSLT (such as path) require that the XSLT be regenerated.
However, the repaint can be suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.
true, the view of this object is immediately updated, obviating the need to call repaint().jsxtext, ssn, phone.
Column.DEFAULT_VALUE_TEMPLATE.
[instance].getPath(). For example: jsxtextjsx3.gui.Matrix.Column.DEFAULT_WIDTH
true.jsx3.gui.Matrix.Column instances to
format cells of data.| Method Summary | |
|---|---|
| abstract void | format(objDiv : HTMLElement, strCDFKey : String, objMatrix : jsx3.gui.Matrix, objMatrixColumn : jsx3.gui.Matrix.Column, intRowNumber : int, objServer : jsx3.app.Server) Formats the Matrix cell, a native DIV element. |
| static jsx3.gui.Matrix.ColumnFormat | Returns a column formatter for a string key. |
| boolean | validate() Classes that implement this interface must provide this method to allow for browser-specific or similar type 'switch'. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
@unescape – @unescape_all – @lookup – @datetime[,(short|medium|long|full,format)] – @date[,(short|medium|long|full,format)] – @time[,(short|medium|long|full,format)] – @number[,(integer|percent|currency,format)] – @message,format
– jsx3.gui.Form interface will have the methods in this interface
inserted into it. If the edit mask does not implement jsx3.gui.Form but extends
jsx3.gui.Block, the methods in the jsx3.gui.Matrix.BlockMask interface are inserted
instead.| Method Summary | |
|---|---|
| void | Commits the current edit session of this edit mask. |
| boolean | emBeginEdit(strValue : String, objTdDim : Object<String, int>, objPaneDim : Object<String, int>, objMatrix : jsx3.gui.Matrix, objColumn : jsx3.gui.Matrix.Column, strRecordId : String, objTD : HTMLElement) Called whenever an edit session begins. |
| String | Called when the current edit session ends. |
| Object<String, Object> | Returns the state of the current edit session if this object is involved in a jsx3.gui.Matrix
edit mask session. |
| String | Returns the current value stored in the edit mask. |
| void | emInit(objColumn : jsx3.gui.Matrix.Column) This method is called once when the edit mask is discovered by the matrix column to give it an opportunity
to initialize itself. |
| void | Resumes an edit session so that the edit session will close the next time this mask loses focus. |
| void | Suspends an edit session so that if this mask loses focus, the edit session does not close. |
| Method Detail |
|---|
true then the current value of this edit mask is committed without
closing the current edit session.
false to cancel the edit session.
jsx3.gui.Matrix
edit mask session. The state has the following keys:
null
Form.doKeyBinding(). If this attribute is of the
form {.*}, then the text between the curly brackets is interpreted as the key of a
dynamic property.| Field Summary | |
|---|---|
| static String | background-image:url(JSX/images/menu/bg.gif);backround-repeat:repeat-y; (default)
|
| static String | #ffffff (default)
|
| static int | |
| static String | Deprecated. |
| static String | |
| static String | Deprecated. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | Deprecated. No-op.
|
| jsx3.gui.Menu | deselectItem(strRecordId : String) flags a a menu item as being unselected (the default state) |
| jsx3.gui.Menu | disableItem(strRecordId : String) disables a menu item with the given id; this ID is the jsxid attribute on the record adhereing to the JSX Common Data Format (CDF); |
| int | Sets the validation state for the menu and returns the validation state. |
| jsx3.gui.Menu | enables a menu item with the given id by removing its 'jsxselected'; this ID is the jsxid attribute on the record adhereing to the JSX Common Data Format (CDF); |
| jsx3.gui.Menu | executeRecord(strRecordId : String) Executes the specific jsxexecute code for the menu record. |
| void | Returns the JSX GUI object that owns (contains) the context item (a CDF record) being acted upon. |
| void | Returns the CDF record ID for the context item being acted upon. |
| int | Returns whether this menu renders a visual divider on its left side. |
| String | getImage() Returns url for 16x16 pixel image (preferably a gif with a transparent background); returns null if no image specified or an empty string |
| String | getValue() Returns the jsxid value in the CDF for the menu item last executed; returns null if unavailable |
| static String | Deprecated. |
| boolean | isItemEnabled(strRecordId : String) Returns whether a record is enabled. |
| boolean | isItemSelected(strRecordId : String) Returns whether a record is selected. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.Menu | resets the cached DHTML content; hides any open menu; when the menu is next expanded (repainted), the update will be relected |
| jsx3.gui.Menu | flags a a menu item as being selected; if the menu item is part of a group (e.g. |
| jsx3.gui.Menu | Sets whether this menu renders a visual divider on its left side. |
| jsx3.gui.Menu | Sets url for 16x16 pixel image (preferably a gif with a transparent background);
returns a reference to self to facilitate method chaining |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState, setValue |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
jsxexecute code for the menu record. This method also fires
EXECUTE event for this menu but only under the deprecated 3.0 model event protocol.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.true, the view will be updated without requiring a repaint.| Method Summary | |
|---|---|
| String | int | Returns the number format as set with setFormat(). |
| void | Sets the format of this number input. |
| Methods Inherited From jsx3.gui.TextBox |
|---|
| beep, doValidate, formatValue, getDefaultValue, getMaxLength, getReadonly, getType, getValidationExpression, getValidationType, getValue, getWrap, paint, parseValue, setDefaultValue, setMaxLength, setOverflow, setReadonly, setType, setValidationExpression, setValidationType, setValue, setWrap |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Method Detail |
|---|
jsx3.util.NumberFormat.
The provided format may also be an integer, in which case it is intepreted as one of of the fields of
NumberFormat - NUMBER, INTEGER, or CURRENCY - and
the displayed format will be localized accordingly.| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| HTMLElement | focus() gives focus to the on-screen VIEW for the element; returns a handle to the html/dhtml element as exposed by the native browser |
| Object<String, int> | Returns the absolute positioning of the object's on-screen view in relation to JSXROOT (whose left/top is 0/0). |
| String | getAttribute(strName : String) Returns the value for the custom attribute with the given name. |
| Object<String, String> | Returns handle to the JavaScript Object Array containing all events for the JSX GUI object;
NOTE: This object will contain zero or more JavaScript Objects with the following Properties: script, type, system |
| String | getDynamicProperty(strName : String) Returns the value of the dynamic property @strPropName; if not found, returns null |
| HTMLElement | getRendered(objGUI : Object | jsx3.gui.Event) Returns handle/reference to the JSX GUI Object's on-screen counterpart—basically a handle to a DHTML object such as a DIV, SPAN, etc |
| jsx3.gui.Painted | insertHTML(objChild : jsx3.gui.Painted) Deprecated. Replaced with paintChild(). |
| protected void | onAfterPaint(objGUI : HTMLElement) A hook that subclasses of Painted may override in order to perform additional manipulation of the HTML DOM
created by the paint method. |
| protected void | onAfterRestoreView(objGUI : HTMLElement) Subclass if restoring of the CSS display of the object necessitates any cleanup of the view. |
| abstract String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| void | paintChild(objChild : jsx3.gui.Painted, bGroup : boolean, objGUI : HTMLElement, bCascadeOnly : boolean) Paints a child of this object without repainting this entire object. |
| String | Iterates through children and returns concatenation of paint() method for all children. |
| void | Removes the box model abstraction for a given object and its descendants. |
| jsx3.gui.Painted | removeAttribute(strName : String) removes the specific custom property bound to this object; returns a reference to self (this) to facilitate method chaining |
| jsx3.gui.Painted | removes all events bound to this object; NOTE: The object must still be painted/repainted for its corresponding on-screen view to be likewise updated; returns a reference to self (this) to facilitate method chaining |
| String | repaint() Updates the view of this object by calling paint() and replacing the current view with the
returned HTML. |
| jsx3.gui.Painted | Sets a property on the object that when the object is rendered on-screen, the HTML tag will be assigned the given name/value pair as a tag attribute |
| jsx3.gui.Painted | Assigns a dynamic property to one of this object's instance properties. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
undefined if no such attribute exists.
paintChild().true if this method is being called iteratively over a collection of
children. This parameter will only be false on the final call in the iteration.this.getChildren() is used.paint() and replacing the current view with the
returned HTML. This method has no effect if this object is not currently displayed.paint() or null if this object is not displayed. true, this dynamic property will not be serialized with the object.groupName property.
No more than one radio button of the set of radio buttons sharing a single groupName value may be
selected at one time.
| Field Summary | |
|---|---|
| static String | jsx30radio
|
| static int | Value for the selected field indicating a selected radio button. |
| static int | Value for the selected field indicating an unselected radio button. |
| Constructor Summary | |
|---|---|
| void | init(strName : String, vntLeft : int | String, vntTop : int | String, vntWidth : int | String, vntHeight : int | String, strText : String, strValue : String, strGroupName : String, intSelected : int) The instance initializer. |
| Method Summary | |
|---|---|
| int | Validates that this radio button is selected if it is required. |
| int | Returns the default selection state of this radio button. |
| String | Returns the group name of this radio button, which is equivalent to the name property on a
standard HTML radio button. |
| String | Returns the value of the selected radio button in the radio group of this radio button. |
| int | Returns the current selection state of this radio button. |
| Array<jsx3.gui.RadioButton> | getSiblings(bRendered : boolean) Returns the list of sibling radio buttons. |
| static String | Deprecated. Use getGroupValue() instead. |
| String | getValue() Returns the value of this radio button. |
| static String | Deprecated. |
| String | paint() Returns the serialized DHTML representation of this object. |
| jsx3.gui.RadioButton | setDefaultSelected(intSelected : int) Sets the default selection state of this radio button. |
| void | setGroupName(strGroupName : String) Sets the group name of this radio button. |
| void | setGroupValue(strValue : String) Sets the selected radio button of the radio group of this radio button by value. |
| jsx3.gui.RadioButton | Sets the current selection state of this radio button. |
| static jsx3.gui.RadioButton | Deprecated. Use setGroupValue() instead. |
| jsx3.gui.RadioButton | Sets the value of this radio button. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
value property on a standard HTML radio button).name property on a standard HTML radio button).SELECTED or
UNSELECTED. null is equivalent to SELECTED.
| Method Detail |
|---|
jsx3.gui.Form.STATEVALID or jsx3.gui.Form.INSTATEVALID.
getSelected().SELECTED or UNSELECTED. name property on a
standard HTML radio button.null if no button is selected.
getGroupValue() instead.null is returned. This method only queries radio groups that are currently rendered
on screen.SELECTED or UNSELECTED.intSelected is equal to SELECTED
any other radio buttons in the radio group of this object will be unselected.SELECTED or null, this object is selected, otherwise it
is unselected.setGroupValue() instead.| Field Summary | |
|---|---|
| static String | The URL of the arrow image. |
| static String | Deprecated. |
| static String | Deprecated. Renamed to DEFAULTXSLURL.
|
| static String | Deprecated. |
| static String | jsx30select_select
|
| static String | Deprecated. This value is now localized.
|
| static String | The URL of the default XSL template of a normal select box. |
| static String | Deprecated. This value is now localized.
|
| static String | Deprecated. This value is now localized.
|
| static String | The URL of the mouse over background image. |
| static String | The URL of the selected background image. |
| static String | Deprecated. |
| static String | Deprecated. Renamed to DEFAULTXSLURL.
|
| static int | The number of milliseconds of delay for the combo typeahead function. |
| static int | Value of the type field indicating a combo select box. |
| static int | Value of the type field indicating a normal select box. |
| Constructor Summary | |
|---|---|
| void | init(strName : String, vntLeft : int | String, vntTop : int | String, vntWidth : int | String, vntHeight : int | String, strSelectedValue : String) The instance initializer. |
| Method Summary | |
|---|---|
| int | Returns STATEVALID if this select box is not required or if it is required and its value is not
empty. |
| HTMLElement | focus() Gives focus to this select box. |
| String | Returns the text to display in this select box if the value of this select box is null. |
| String | Returns the URL to use for the dropdown image. |
| int | Returns the maximum length allowed for the input field of this combo control. |
| String | getText() If this is a normal select box returns the value of the jsxtext attribute of the selected CDF record,
or if this is a combo select box returns the current value. |
| int | getType() Returns the type of this select box. |
| String | getValue() Returns the value of this select box. |
| static String | Deprecated. |
| jsx3.xml.Document | getXSL() Returns the XSL appropriate to the select type (either combo or select) if no custom XSLT is specified. |
| void | Hides the drop-down portion of this select control. |
| String | paint() Returns the DHTML representation of this select box. |
| jsx3.gui.Select | Redraws one record from the CDF data source of this select box. |
| jsx3.gui.Select | setDefaultText(strDefaultText : String) Sets the text to display in this select box if the value of this select box is null. |
| void | Sets the URL to use for the dropdown image (16x16). |
| jsx3.gui.Select | setMaxLength(intMaxLength : int) Sets the maximum length allowed for the input field of this combo control. |
| jsx3.gui.Select | Deprecated. |
| jsx3.gui.Select | Sets the type of this select box. |
| jsx3.gui.Select | Sets the selected record of this select control. |
| void | show() Displays the list of options for this select box. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
DEFAULTXSLURL.
DEFAULTXSLURL.
| Constructor Detail |
|---|
| Method Detail |
|---|
STATEVALID if this select box is not required or if it is required and its value is not
empty. If this select is of type combo then any value other than an empty string is valid, otherwise only values
corresponding to an actual CDF record of this select are valid.jsx3.gui.Form.STATEVALID or jsx3.gui.Form.STATEINVALID.
null.
If no value has been explicitly set with setDefaultText() a value appropriate to the server locale
is returned.TYPECOMBO.jsxtext attribute of the selected CDF record,
or if this is a combo select box returns the current value.jsxid attribute of the selected CDF record.null if no record is selected.
true, the form control will be focused after hiding the drop-down.
strRecordId is equal to the
selected record id, the text of this select box is set to the value of the record's jsxtext attribute.INSERT, UPDATE, or DELETE.null.getText() either.TYPESELECT or TYPECOMBO.SELECT event only under the deprecated
3.0 model event protocol.getValue()
method as well as the event handlers.| Field Summary | |
|---|---|
| static int | Orientation value for a horizontal slider. |
| static int | Orientation value for a vertical slider. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| Number | constrainValue(fpValue : Number) Constrains a possible slider value to a legal value. |
| int | Sets the validation state for this slider and returns the validation state. |
| String | Returns the URL of the image to use for the handle. |
| int | String | Returns the value of the length field, the size of the dimension along this slider axis. |
| int | Returns the orientation of this slider. |
| int | Returns whether the track is painted. |
| int | Returns whether clicking the track moves the handle to that point. |
| Number | getValue() Returns the value of this slider. |
| static String | Deprecated. |
| String | paint() Paints this slider. |
| jsx3.gui.Slider | setHandleImage(strUrl : String) Sets the URL of the image to use for the handle. |
| jsx3.gui.Slider | Sets the length of this slider. |
| jsx3.gui.Slider | setOrientation(intValue : int) Sets the orientation of this slider. |
| jsx3.gui.Slider | setPaintTrack(bValue : int) Sets whether the track is painted. |
| jsx3.gui.Slider | setTrackClickable(bValue : int) Sets whether clicking the track moves the handle to that point. |
| jsx3.gui.Slider | Sets the value of this slider and repositions the handle. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.gui.Slider to
create a "notched" slider. The following code creates a slider that allows its handle to be in a location
corresponding to a value that is a multiple of 10:
objSlider.constrainValue = function(fpValue) {
return Math.max(0, Math.min(100, jsx3.util.numRound(fpValue, 10)));
}
fpValue that is legal for this slider.
jsx3.gui.Form.STATEVALID.
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.
HORIZONTAL or VERTICAL.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.| Field Summary | |
|---|---|
| static void | Apple Quicktime sound plugin type. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| float | Returns the length of the sound in seconds. |
| String | Returns the full name and version number of the audio plugin used to play this sound. |
| float | Returns the current position (elapsed time) of the sound in seconds. |
| String | getURL() Returns the URL of the sound file. |
| int | Returns the volume that the sound plays at. |
| String | paint() Paints the container for the sound. |
| void | pause() Pauses the sound. |
| void | play() Plays the sound. |
| void | rewind() Stops and rewinds the sound. |
| void | setPosition(position : float) Sets the current position (elapsed time) of the sound in seconds. |
| jsx3.gui.Sound | Sets the URL of the sound file. |
| jsx3.gui.Sound | Sets the volume of this sound. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
NaN if the length can not be determined
NaN if the position can not be determined
play() after calling pause() will play the sound from the
point where it was paused.
| Field Summary | |
|---|---|
| static int | |
| static int | |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| int | Returns whether the user can resize this control |
| String | Returns the URL for the image to use for the splitter handle when the splitter is rendered side by side ( | ). |
| int | *Returns whether the splitter layout is top-over (--) or side-by-side (|). |
| int | Returns a valid integer representing the minimum size in pixels for the container; the default minimum is 1 |
| String | Returns a valid percentage (e.g. |
| int | Returns a valid integer representing the minimum size in pixels for the container; the default minimum is 8 |
| String | Returns the URL for the image to use for the splitter handle when the splitter is rendered top over bottom (--). |
| static String | Deprecated. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.Splitter | subclassed method. |
| void | setEnabled(intEnabled : int) Sets whether the user can resize this control. |
| jsx3.gui.Splitter | setHSplitImage(strURL : String) Sets the URL for the image to use for the splitter handle when the splitter is rendered side by side ( | ). |
| jsx3.gui.Splitter | setOrientation(ORIENTATION : int) Returns whether the splitter layout is top-over (--) or side-by-side (|);
returns reference to self to facilitate method chaining |
| jsx3.gui.Splitter | setSubcontainer1Min(intMin : int) Sets the minimum size in pixels for the container; the default minimum is 1;
returns reference to self to facilitate method chaining |
| jsx3.gui.Splitter | Sets a valid percentage (e.g. |
| jsx3.gui.Splitter | setSubcontainer2Min(intMin : int) Sets the minimum size in pixels for the container; the default minimum is 8;
returns reference to self to facilitate method chaining |
| jsx3.gui.Splitter | setVSplitImage(strURL : String) Sets the URL for the image to use for the splitter handle when the splitter is rendered top over bottom (--). |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
Splitter.HSPLITIMAGE will be used when painted on-screen.Splitter.VSPLITIMAGE will be used when painted on-screen.0 or 1. Note: null is
equivalent to 1.
100,* or *,250.| Field Summary | |
|---|---|
| static String | #aaccff
|
| static String | |
| static String | border:solid 1px #9898a5;border-left-color:#ffffff;border-top-color:#ffffff;
|
| static String | #ffffff
|
| static String | #e8e8f5
|
| static int | 1 |
| static int | 0 (default) |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| void | doShow() Makes this stack the visible (expanded) stack in the parent stack group. |
| void | Deprecated. use doShow() instead. |
| void | focus() overrides method is superclass; ensures the stack is expanded before giving focus
|
| String | Returns valid CSS property value, (i.e. |
| jsx3.app.Model | Returns the child of this stack that will be painted as the content of this stack. |
| String | Returns valid CSS property value, (i.e. |
| static String | Deprecated. |
| boolean | isFront() Returns whether or not this stack is the active (expanded) stack |
| boolean | onSetParent(objParent : ?) is called when an item is about to be set; returns false if the parent is not of the appropriate type; in this case, the parent must be a jsx3.gui.List or derivative class |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.Stack | setActiveColor(strActiveColor : String) Sets valid CSS property value, (i.e. |
| jsx3.gui.Stack | setInactiveColor(strInactiveColor : String) Sets valid CSS property value, (i.e. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
doShow() instead.EXECUTE
model event only under the deprecated 3.0 model event protocol. Invokes the SHOW model event.| Field Summary | |
|---|---|
| static int | 27 (default)
|
| static Array<String> | Deprecated. |
| static int | Deprecated. |
| static int | 1 : side-by-side (|) layout |
| static int | 0 : top-over (--) layout (default) |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| int | Returns the size of the handle common to all child stack instances (in pixels). |
| int | |
| int | Returns zero-based index for the tab that is active per its placement in the child JScript array |
| static String | Deprecated. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.StackGroup | setBarSize(intBarSize : int) Sets the size of the handle for the child stack instances;
returns reference to self to facilitate method chaining |
| jsx3.gui.StackGroup | setOrientation(intOrientation : int) |
| Methods Inherited From jsx3.gui.LayoutGrid |
|---|
| getBestGuess, getCols, getDimensionArray, getRepeat, getRows, setBestGuess, setCols, setDimensionArray, setRepeat, setRows |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.gui.TabbedPane. A tab should have exactly one child, usually a jsx3.gui.Block,
which holds all of its content.| Field Summary | |
|---|---|
| static String | |
| static String | #e8e8f5
|
| static String | #e8e8f5
|
| static String | |
| static String | Deprecated. |
| static String | #d8d8e5
|
| static String | Deprecated. |
| static String | |
| static int | 0 : disabled |
| static int | 1 : enabled (default) |
| Constructor Summary | |
|---|---|
| void | init(strName : String, strText : String, vntWidth : int | String, strHexActiveColor : String, strHexInactiveColor : String) instance initializer |
| Method Summary | |
|---|---|
| jsx3.gui.Tab | Deprecated. replaced with doShow() |
| void | doShow() Brings this tab and its associated pane forward in the stack among all sibling tabs. |
| String | Returns the CSS background-color property value, (i.e. |
| String | getBevel() Returns background image that will underlay each tab to provide an outset-type border. |
| jsx3.app.Model | Returns the child of this tab that will be painted as the content of this tab. |
| int | Returns the state for the tab control. |
| String | Returns the CSS background-color property value, (i.e. |
| static String | Deprecated. |
| boolean | isFront() Returns whether or not this stack is the active (expanded) stack |
| boolean | onSetParent(objParent : ?) Called when an item is about to be set; returns false if the parent is not of the appropriate type; in this case, the parent must be a jsx3.gui.TabbedPane or derivative class |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.Tab | setActiveColor(strActiveColor : String) Sets the CSS background-color property value, (i.e. |
| jsx3.gui.Tab | Sets background image that will underlay each tab to provide an outset-type border; if this value is not set or null is passed, the default background image for the jsx3.gui.Tab class will be use the contant value, jsx3.gui.Tab.DEFAULTBEVELIMAGE; |
| jsx3.gui.Tab | setEnabled(STATE : int) Sets the enabled state for the tab control; returns reference to self to facilitate method chaining |
| jsx3.gui.Tab | setInactiveColor(strInactiveColor : String) Sets the CSS background-color property value, (i.e. |
| jsx3.gui.Tab | Sets the text/HTML for the control to be displayed on-screen;
returns reference to self to facilitate method chaining; |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
doShow()EXECUTE event only under the deprecated 3.0 event protocol.setFocus.jsx3.gui.Tab.DEFAULTACTIVECOLOR
jsx3.gui.Tab.DEFAULTINACTIVECOLOR
jsx3.gui.Tab.DEFAULTACTIVECOLOR
jsx3.gui.Tab.STATEDISABLED, jsx3.gui.Tab.STATEENABLEDjsx3.gui.Tab.DEFAULTINACTIVECOLOR
true, the view of this object is immediately updated, obviating the need to call repaint().| Field Summary | |
|---|---|
| static int | 50
|
| static int | 20 (default)
|
| static String | jsx:///images/tab/l.png
|
| static String | jsx:///images/tab/r.png
|
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| int | Returns the zero-based child index of the active child tab. |
| void | whether or not to show the tabs of the tabbed pane. |
| int | Returns the CSS height property (in pixels) for child tabs |
| static String | Deprecated. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.TabbedPane | Sets the active tab of this tabbed pane. |
| void | setShowTabs(intShowTabs : ?) whether or not to show the tabs of the tabbed pane. |
| jsx3.gui.TabbedPane | setTabHeight(intTabHeight : int) Sets the CSS height property for the object (in pixels) for child tabs;
returns reference to self to facilitate method chaining |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
true, immediately updates the view to reflect the new active tab.jsxid
jsxselected
jsxstyle
jsxclass
jsximg
jsxtip
jsxunselectable
jsxexecute
EXECUTE –MENU –CHANGE –SPYGLASS –| Field Summary | |
|---|---|
| static String | |
| static jsx3.xml.Document | Default XSL template for rendering the cell value for all cells. |
| static int | 20
|
| static String | jsx:///images/table/select.gif
|
| static int | Enum value for the multiSelect property indicating a single-select table. |
| static int | Enum value for the multiSelect property indicating a multi-select table. |
| static int | Enum value for the multiSelect property indicating an unselectable table. |
| static String | ascending |
| static String | jsx:///images/table/sort_asc.gif (default)
|
| static String | descending |
| static String | jsx:///images/table/sort_desc.gif (default)
|
| static String | number |
| static String | text (default) |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| void | Deselects all selected CDF records. |
| void | deselectRecord(strRecordId : String) Deselects a CDF record within the Table. |
| void | Sorts according to the current sort path. |
| int | validates the Table; if the Table is set to 'required', a selection must be made to pass validation. |
| void | focusRowById(strCdfId : String) Applies focus to the on-screen row indentified by the CDF record id that generated it |
| String | getAlternateRowClass(strDefault : String) Returns the CSS rule for the HTML row element(s) containing the alternating table data rows. |
| String | getAlternateRowStyle(strDefault : String) Returns the CSS properties for the HTML row element(s) containing the alternating table data rows. |
| int | Returns whether the table is sortable. |
| String | Returns the CSS rule that will be applied to every HTML cell in the body of the table. |
| String | Returns the CSS properties that will be inlined on every HTML cell in the body of the table. |
| String | Returns the string of XML in CDF format representing the Column Profile Document. |
| jsx3.xml.CDF.Document | Returns a clone of the CDF document used internally to define the Columns (text, order, mapped attributes, etc). |
| HTMLElement | Returns the on-screen cell that represents the intersection of the row identified
by strCdfId and the first cell mapped to the named CDF attribute, strAttName. |
| String | getHeaderClass(strDefault : String) Returns the CSS rule for the HTML row containing the column headers. |
| int | getHeaderHeight(strDefault : String) Returns the height of the header row in pixels. |
| String | getHeaderStyle(strDefault : String) Returns the CSS style for the HTML row containing the column headers. |
| String | Returns the text/HTML to display on-screen when the xml/xsl transformation for this object results in a null or empty result set |
| String | getRenderingContext(strDefault : String) Returns the jsxid of the CDF record that will serve as the origin when rendering the data on-screen. |
| String | Returns the CSS rule for the HTML row element(s) containing the table data. |
| String | Returns the CSS properties for the HTML row elements(s) containing the table data. |
| Array<String> | Returns the jsxid(s) for the selected record(s). |
| jsx3.util.List<jsx3.xml.Entity> | Returns the collection of selected records. |
| String | getSelectionBG(strDefault : String) Returns the CSS string to apply to a Row/Cell when it has focus |
| int | getSelectionModel(strDefault : String) Returns the selection model. |
| String | Returns the direction (jsx3.gui.Table.SORT_ASCENDING or jsx3.gui.Table.SORT_DESCENDING) for the sorted column; if no direction specified, ascending is returned |
| String | Returns the name of the CDF attribute to sort on. |
| String | Returns the data type to be used for sorting this list. |
| String | Array<String> | getValue() Returns an array of selected values (or empty array) if the selection model is Table.SELECTION_MULTI_ROW. |
| String | getValueTemplate(strDefault : String) Gets the user-defined XSL template (xsl:template) that will override the defualt template defined by Table.DEFAULT_CELL_VALUE_TEMPLATE. |
| int | Returns whether or not the table's data cells support text-wrapping and expand vertically to display their wrapped content. |
| jsx3.xml.Document | getXSL() Returns XSLT for the Table, prioritizing the acquisition in the following order: 1) check cache; 2) check jsxxsl; 3) check jsxxslurl; 4) use default |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.Table | This method implements redraw support by repainting the entire control. |
| void | Paints only the data rows. |
| void | Paints only the header row. |
| void | selectRecord(strRecordId : String) Selects a CDF record of this list. |
| void | setAlternateRowClass(strRuleName : String) Sets the CSS rule for the HTML row element(s) containing the alternating table data rows. |
| void | setAlternateRowStyle(strCSS : String) Sets the CSS properties for the HTML row element(s) containing the alternating table data rows. |
| void | setCanSort(SORT : int) Sets whether the table is sortable. |
| void | setCellClass(strRuleName : String) Sets the CSS rule that will be applied to every HTML cell in the body of the table. |
| void | setCellStyle(strCSS : String) Sets the CSS properties that will be inlined on every HTML cell in the body of the table. |
| void | setColumnProfile(objCDF : String | jsx3.xml.CDF.Document) Sets a string of XML (in CDF format) or an actual jsx3.xml.CDF.Document instance representing the Column Profile Document. |
| void | setHeaderClass(strRuleName : String) Sets the CSS rule for the HTML row containing the column headers. |
| void | Sets the height of the header row in pixels. |
| void | setHeaderStyle(strCSS : String) Sets the CSS style properties for the HTML row containing the column headers. |
| void | Sets the jsxid of the CDF record that will serve as the origin when rendering the data on-screen. |
| void | setRowClass(strRuleName : String) Sets the CSS rule for the HTML row element(s) containing the table data. |
| void | setRowStyle(strCSS : String) Sets the CSS properties for the HTML row element(s) containing the table data. |
| void | setSelectionBG(strURL : String) Sets the URL for the image to use (as the repeating background image) to denote selection. |
| void | setSelectionModel(intType : int) Sets the selection model |
| void | setSortDirection(intSortDir : String) Sets the direction (ascending or descending) for the sorted column. |
| void | setSortPath(strAttr : String) Sets the name of the CDF attribute to sort on. |
| void | setSortType(DATATYPE : String) Sets the data type for the list. |
| jsx3.gui.Table | Sets the value of this table. |
| void | setValueTemplate(TEMPLATE : String) Sets the user-defined XSL template that will override the defualt template defined by Table.DEFAULT_CELL_VALUE_TEMPLATE. |
| void | Sets whether or not the table's data cells support text-wrapping and expand vertically to display their wrapped content. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
match on a record element (match="record") and will
be used for all data cells in the body of the table. This template will be passed one named parameter (xsl:param) named
attname, the name of the attribute to which the column is mapped.multiSelect property indicating a single-select table.multiSelect property indicating a multi-select table.multiSelect property indicating an unselectable table.| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.gui.Table.SORT_ASCENDING or jsx3.gui.Table.SORT_DESCENDING.null or jsx3.Boolean.TRUE, the instance is sortable.getColumnProfile is not a valid XML document, an empty CDF Document will be returned instead.
Note that if you make changes to the Document returned by this method, those
changes will only be reflected by calling setColumnProfile (to update the model),
followed by a call to repaint (to update the view).strCdfId and the first cell mapped to the named CDF attribute, strAttName.jsxtextnull), the list will render with
the default value of jsx3.gui.Table.DEFAULT_HEADER_HEIGHT.this.getValue() except that the return value is always an Array.SELECTION_ROW)jsx3.gui.Table.TYPE_TEXT or jsx3.gui.Table.TYPE_NUMBER
Table.SELECTION_MULTI_ROW. Returns a string (or null)
for the other selection modelsTable.DEFAULT_CELL_VALUE_TEMPLATE.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
bodyText, normalText.background-color:red;font-family:Arial;.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
boldText titleText.text-align:right;background-color:#eeeeee;border-bottom:solid 1px #aeaeae;.300, or 25%.text (default) or number.
<data jsxid="jsxroot">
<record jsxid="a1" jsxtext="<b>Column 1</b>" jsxpath="jsxtext"/>
<record jsxid="a2" jsxtext="Column 2" jsxwidth="100" jsxpath="value" jsxpathtype="number"/>
</data>
boldText titleText.
The following CSS properties (those affecting layout and position) are not allowed for the rule: width, height,
left, top, position, overflow, border, padding, margin.true to stop the default repaint from occurring.
Typically property updates that affect the browser-specific box model (such as height) are repainted
immediately to keep the box model abstraction in sync with the native view. However, the repaint can be
suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.
background-image:url(JSXAPPS/myproject/images/bg.gif);font-family:Arial;.
The following CSS properties (those affecting layout and position) are not allowed: width, height,
left, top, position, overflow, border, padding, margin.true to stop the default repaint from occurring.
setAlternateRowClass. Multiple rules are supported.
For example: bodyText normalText.setAlternateRowStyle. Multiple properties are supported.
For example: background-color:white;font-family:Arial;.Table.DEFAULT_CELL_VALUE_TEMPLATE.
The template must resolve to a valid XSL Template when parsed. The template should match on a record (match="record"). The template
will be passed a single XSL param (xsl:param) named attname.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
compile method for usage details.| Nested Class Summary | |
|---|---|
| jsx3.gui.Template.Block | Provides base class for creating custom GUI classes. |
| Constructor Summary | |
|---|---|
| void | init() instance initializer
|
| Method Summary | |
|---|---|
| static void | Adds a resolver library. |
| static Object | Adds a resolver to a given resolver set. |
| static void | Converts an HTML template into the relevant JavaScript functions needed by the GUI class. |
| static String | Call this method during GUI class development to see how your XML template is converted into JavaScript by the template compiler. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
getTemplateXML into JavaScript.
//step 1) require the template engine (and all used interfaces)
jsx3.require("jsx3.gui.Template");
//step 2) define the new class
jsx3.lang.Class.defineClass(
"my.custom.Widget", //fully qualified name
jsx3.gui.Template.Block, //super class
[], //interface(s)
function(WIDGET, widget) { //class alias, prototype alias
//step 3) define the init method
widget.init = function(strName) {
this.jsxsuper(strName);
};
//step 4) define the MODEL defaults
WIDGET.XYZ = 'xyz'; //CLASS defaults
widget.xyz = 'xyz'; //prototype defaults
//step 5) define the VIEW template
widget.getTemplateXML = function() {
return ['<transform version="1.0" ' ,
' xmlns="http://gi.tibco.com/transform/" ' ,
' xmlns:u="http://gi.tibco.com/transform/user">' ,
' <template>' ,
' <div onclick="{onclick}" ' ,
' style="position:{$position};left:{$left};background:{bg|red};">' ,
' <text>{mytext|some default text}</text>' ,
' </div>' ,
' </template>' ,
'</transform>'].join("");
};
//6) define the CONTROLLER methods
widget.onclick = function(objEvent, objGUI) {
//show random information
alert(objEvent.clientX() + objGUI.id + WIDGET.XYZ + this.bg);
};
widget.setBG = function(strBG) {
this.setProperty("bg",strBG);
};
widget.setText = function(strText) {
this.setProperty("mytext",strText);
};
});
| Constructor Summary | |
|---|---|
| void | instance initializer
|
| Method Summary | |
|---|---|
| void | clearBoxProfile(bRecurse : boolean) Deletes the existing boxprofile for the object. |
| HTMLElement | Returns the HTML element (the view) corresponding to the box (model) defined by the uniqe identifier, strId
|
| String | jsx3.xml.Document | Returns the XML template definition for the class. |
| void | recalc() Forces the template engine to recalculate the box profile for the instance. |
| void | Sets a property on the instance. |
| void | Similar to setProperty, except that the target GUI element can be specified as the first parameter. |
| void | Synchronize value(s) on the model to value(s) in the view (the view template). |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
strId
getRendered.recalc="true", will cause realc to be called each time
the instance is painted. This means the following two template statements are equivalent:
<template recalc="true">...</template> - or - <template onpaint="this.recalc()">...</template>
obj.setProperty(n1, p1, n2, p2);.
For example, the following two statements are equivalent:
obj.setProperty("jsxbgcolor","red");
obj.setBackgroundColor("red",true);
null, the attribute is removed.
setProperty, except that the target GUI element can be specified as the first parameter. This is useful for repeated
UI updates since it saves the system from resolving objGUI.null, the attribute is removed.setPropery in that setProperty is used to both update
the model and view at the same time. For example, the following two examples are equivalent:
//example 1
obj.setProperty("jsxbgcolor","red");
//example 2
obj.jsxbgcolor = "red";
obj.syncProperty("jsxbgcolor");
[instance].getRendered()| Field Summary | |
|---|---|
| static String | CSS color property
|
| static String | jsx30textbox
|
| static String | as needed by content
|
| static String | none
|
| static String | persistent scrollbars
|
| static int | password type 2 |
| static int | texbox type 0 |
| static int | text area type 1 |
| static String | email |
| static String | letter |
| static String | none |
| static String | numbers only |
| static String | telephone |
| static String | us ssn |
| static String | uszip |
| static int | no wrap |
| static int | wrap text (default) |
| Constructor Summary | |
|---|---|
| void | init(strName : String, vntLeft : int | String, vntTop : int | String, vntWidth : int | String, vntHeight : int | String, strValue : String, TYPE : String) instance initializer |
| Method Summary | |
|---|---|
| void | beep() call to designate an error or alert the user's attention to the textbox on-screen. |
| boolean | Validates the text box against its validation type. |
| protected String | formatValue(value : Object) Formats the value of this text box before displaying it in the onscreen input box. |
| String | Returns value of textbox object when it was first initialized. |
| int | if TYPE for the object is jsx3.gui.TextBox.TYPETEXT, and this returns a positive integer, the maxlen property for the textbox will be set to this value; returns null if no value found |
| int | Returns whether this text box is read only. |
| int | getType() Returns the type of TextBox. |
| String | Returns the custom validation expression (a regular expression pattern to match). |
| String | Returns the ID (CONSTANT) for one of the pre-canned regular expression filters that can be used to validate the user's response. |
| String | getValue() logically tries to determine the value for the text box by 1) checking for value of on-screen VIEW; 2) checking for 'value' property for in-memory MODEL 3) checking getDefaultValue() for value when object was first initialized. |
| static String | Deprecated. |
| String | getWrap() Returns the text-wrapping/ word-breaking property for object if object type is jsx3.gui.TextBox.TYPETEXTAREA. |
| String | paint() Returns the DHTML, used for this object's on-screen view. |
| protected Object | parseValue(input : String) Parses the value of the onscreen input box before it is used as the value of the text box. |
| jsx3.gui.TextBox | setDefaultValue(strValue : String) set during object initialization; useful for tracking edits/updates to an object by doing a string comparison between getValue() and getDefaultValue();
returns a reference to self to facilitate method chaining |
| jsx3.gui.TextBox | setMaxLength(intMaxLength : int) if TYPE for the object is jsx3.gui.TextBox.TYPETEXT, setting this to a positive integer affects the maxlen property for the textbox;
returns a reference to self to facilitate method chaining |
| jsx3.gui.TextBox | setOverflow(OVERFLOW : String) Sets the overflow property of this object, which defines how its on-screen view will behave when its contents
are larger than its specified width and/or height. |
| void | setReadonly(val : int) Sets whether this text box is read only. |
| jsx3.gui.TextBox | Sets the type of jsx3.gui.TextBox
returns a reference to self to facilitate method chaining |
| jsx3.gui.TextBox | setValidationExpression(strValidationExpression : String) Sets the custom validation expression (a regular expression pattern to match). |
| jsx3.gui.TextBox | setValidationType(VALIDATIONTYPE : String) when set, applies one of the pre-canned regular expression filters that can be used to validate the user's response;
returns a reference to self to facilitate method chaining. |
| jsx3.gui.TextBox | updates value property for both on-screen VIEW (if object is painted) and in-memory MODEL;
returns a reference to self to facilitate method chaining |
| jsx3.gui.TextBox | Sets the text-wrapping/ word-breaking property for object if object type is jsx3.gui.TextBox.TYPETEXTAREA. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
re, the following
expression must evaluate to true: this.getValue().search(re) == 0.
String.search() may behave differently than RegExp.test(); consult the JavaScript
documentation for more information.
null value returns the empty string.true) or 0.
TYPETEXTAREA.OVERFLOWNORMAL, OVERFLOWAUTO, or OVERFLOWSCROLL.true) or 0.
24hour property explicitly.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| int | Returns STATEVALID if this time picker is not required or if it is required and its value is not
null, otherwise returns STATEINVALID. |
| Date | Returns a date with the time of day set to the value of this time picker. |
| int | getHours() Returns the hour (0-23) of the time value of this time picker. |
| int | Returns the millisecond (0-999) of the time value of this time picker. |
| int | Returns the minute (0-60) of the time value of this time picker. |
| int | Returns the second (0-60) of the time value of this time picker. |
| int | Returns whether this time picker shows the millisecond input field. |
| int | Returns whether this time picker shows the second input field. |
| String | getValue() Returns the value of this time picker as a formatted string matching the appearance of the control. |
| int | is24Hour() Returns whether this time picker displays with a 24-hour clock. |
| String | paint() |
| jsx3.gui.TimePicker | Sets whether this time picker uses a 24-hour clock. |
| void | Sets the value of this time picker in local time. |
| jsx3.gui.TimePicker | setFontSize(intPixelSize : int) Sets the CSS font-size for the object;
returns reference to self to facilitate method chaining; |
| void | Sets the hour value of this time picker. |
| void | setMilliseconds(intMillis : int) Sets the millisecond value of this time picker. |
| void | setMinutes(intMinutes : int) Sets the minute value of this time picker. |
| void | setSeconds(intSeconds : int) Sets the second value of this time picker. |
| jsx3.gui.TimePicker | setShowMillis(bShow : boolean) Sets whether this time picker shows the millisecond input field. |
| jsx3.gui.TimePicker | setShowSeconds(bShow : boolean) Sets whether this time picker shows the second input field. |
| jsx3.gui.TimePicker | Sets the value of this time picker in local time. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
STATEVALID if this time picker is not required or if it is required and its value is not
null, otherwise returns STATEINVALID.objDate parameter with the time of day set in local time or, if objDate is not provided,
it returns a new date (the current day) with the time of day set.showSeconds are true.null to use the locale default value.EXECUTE – when the user clicks on the enabled button, when the button has focus and the user presses the
space or enter key, or when doExecute() is called on the button.CHANGE – when the state of a check or radio type button changes through user interaction or when
setState() is called under the deprecated 3.0 model event protocol.MENU – on a mouseup event with the right button when the button has a bound context menu.| Field Summary | |
|---|---|
| static int | Value of the state field indicating the up/off state. |
| static int | Value of the state field indicating the down/on state. |
| static int | Value of the type field indicating a check button. |
| static int | Value of the type field indicating a normal (stateless) button. |
| static int | Value of the type field indicating a radio button. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | doClick() Deprecated. Use doExecute() to invoke the EXECUTE model event programmatically. |
| void | doExecute(objEvent : jsx3.gui.Event) Invokes the EXECUTE model event of this toolbar button. |
| int | Validates this button based on the type of button and whether this control is required. |
| String | Returns the URL of the image to use when this button is disabled. |
| int | Returns whether this toolbar button renders a visual divider on its left side. |
| String | Returns the name of the group to which this radio button belongs. |
| String | getImage() Returns the URL of the image to use to render this button. |
| int | getState() Returns the state of this button. |
| int | getType() Returns the type of this button. |
| static String | Deprecated. |
| String | paint() Returns this toolbar button serialized to HTML. |
| jsx3.gui.ToolbarButton | setDisabledImage(strURL : String) Sets the URL of the image to use when this button is disabled. |
| jsx3.gui.ToolbarButton | Sets whether this toolbar button renders a visual divider on its left side. |
| jsx3.gui.ToolbarButton | setGroupName(strGroupName : String) Sets the name of the group to which this radio button belongs. |
| jsx3.gui.ToolbarButton | Sets the URL of the image to use to render this button. |
| jsx3.gui.ToolbarButton | Sets the state of this button. |
| jsx3.gui.ToolbarButton | Sets the type of this button. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, getValue, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState, setValue |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
TYPENORMAL, or TYPECHECK,
TYPERADIO.| Method Detail |
|---|
doExecute() to invoke the EXECUTE model event programmatically.EXECUTE model event of this toolbar button.EXECUTE model event of this toolbar button. Note that because the model event is invoked
programmatically rather than by user interaction the objEVENT event parameter will be
null if the objEvent parameter is undefined. If this is a radio button its state is
set to on. If this is a check button, its state is toggled.objEVENT.
jsx3.gui.Form.STATEVALID or jsx3.gui.Form.STATEINVALID. jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.
null if this
button is not a radio button.STATEOFF. Radio and check
buttons may return STATEOFF or STATEON.STATEON or STATEOFF. TYPENORMAL, or TYPECHECK, or TYPERADIO.
jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.CHANGE model event only under the deprecated 3.0 model event protocol.
STATEON or STATEOFF.TYPENORMAL, or TYPECHECK, TYPERADIO.jsxid
jsxselected
jsxstyle
jsxclass
jsxopen
jsximg
jsxlazy (see model event DATA)jsxtip
jsxtext
jsxunselectable
DATA –EXECUTE –SELECT (deprecated) –MENU –TOGGLE –CHANGE –SPYGLASS –ADOPT –DROP/CTRL_DROP/BEFORE_DROP/CANCEL_DROP –| Field Summary | |
|---|---|
| static String | jsx:///images/matrix/append.gif
|
| static String | Deprecated. Use CSS instead.
|
| static String | #ffffff (default)
|
| static String | (default)
|
| static String | Deprecated. |
| static String | |
| static String | JSX/images/tree/file.gif (default)
|
| static String | JSX/images/tree/minus.gif (default)
|
| static String | JSX/images/tree/plus.gif (default)
|
| static String | jsx:///images/matrix/insert_before.gif
|
| static int | Enum value for the multiSelect property indicating a multi-select tree. |
| static String | Deprecated. |
| static String | JSX/images/tree/select.gif (default)
|
| static int | Enum value for the multiSelect property indicating a single-select tree. |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| int | validates the Tree; if the Tree is set to 'required', a selection must be made to pass validation. |
| void | executeRecord(strRecordId : String) Executes any bound code for the record with id strRecordId. |
| String | getIcon() Returns the Icon to use for items in the tree. |
| String | Returns the Icon to use when a node is in an open state. |
| String | Returns the Icon to use when the given tree node is in an closed state. |
| int | Deprecated. Key navigation now works with sorted trees.
|
| int | Returns whether this tree is multi- (Tree.MULTI) or single-select (Tree.SINGLE). |
| String | Returns the text/HTML to display on-screen when the xml/xsl transformation for this object results in a null or empty result set |
| int | getRoot() Returns whether or not the tree should paint its root node or paint the direct child nodes to the VIEW without rendering their containing root. |
| String | getText() Deprecated. |
| String | Array<String> | getValue() Returns the jsxid attribute for the selected CDF record/records. |
| static String | Deprecated. |
| jsx3.xml.Document | getXSL() Returns XSLT for the Tree, prioritizing the acquisition in the following order: 1) check cache; 2) check jsxxsl; 3) check jsxxslurl; 4) use default |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.Tree | if @strRecordId equals the id of the selected option (this.getValue()), only the text property will update;
returns a ref to self to facilitate method chaining |
| void | Reveals a record by toggling parent nodes as necessary and scrolling any containing blocks within the tree. |
| jsx3.gui.Tree | Sets the Icon to use for items in the tree; returns a ref to self |
| jsx3.gui.Tree | setIconMinus(strURL : String) Sets the Icon to use when a node is in an open state. |
| jsx3.gui.Tree | setIconPlus(strURL : String) Sets the Icon to use when the given tree node is in an closed state |
| jsx3.gui.Tree | setKeyListener(bBoolean : int) Deprecated. Key navigation now works with sorted trees.
|
| jsx3.gui.Tree | setMultiSelect(intMulti : int) Sets whether this tree is multi- (Tree.MULTI) or single-select (Tree.SINGLE). |
| jsx3.gui.Tree | Sets whether or not the tree should paint its root node or paint the direct child nodes to the VIEW without rendering their containing root; |
| jsx3.gui.Tree | Selects a record in the tree. |
| jsx3.gui.Tree | toggles the open/closed state for a node on the tree; updates both MODEL and VIEW; if the tree is not yet
painted and the open state for a node needs to be set, call: [tree instance].insertRecordProperty(@strId,@strPropName,@strPropValue,false);
if there is a VIEW for the item, the 'ontoggle' event will be fired; if the developer has bound an ontoggle script
(e.g. |
| Methods Inherited From jsx3.gui.Form |
|---|
| doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState |
| Methods Inherited From jsx3.xml.Cacheable |
|---|
| clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
multiSelect property indicating a multi-select tree.multiSelect property indicating a single-select tree.| Constructor Detail |
|---|
| Method Detail |
|---|
strRecordId. This method only invokes the
EXECUTE model event for this tree under the deprecated 3.0 model event protocol.jsxid value for the record node (according to the CDF) to execute
Tree.MULTI) or single-select (Tree.SINGLE).null if none
selected; if multi-select an array of the selected record ids.
overflow:expand and the containing block is set to overflow:scroll.
Tree.MULTI) or single-select (Tree.SINGLE).Tree.MULTI or Tree.SINGLEjsx3.app.Server class:
| Field Summary | |
|---|---|
| static String | Event subject: published after this window has received focus. |
| static String | Event subject: published after this window has successfully opened. |
| static String | Event subject: published after this window has been resized via user interaction. |
| static String | Event subject: published after this window's parent has closed. |
| static String | Event subject: published just before this window will close. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| boolean | close() Closes the browser window of this window instance. |
| void | Ensures that this window is at least partially visible on the computer screen. |
| void | doClose() Closes the native browser window bound to this window instance AND removes this instance and its descendants from the GI DOM. |
| void | focus() Focuses the browser window of this window instance. |
| int | Returns the inner (visible) height of this window. |
| int | Returns the current x-coordinate screen position of this browser window relative to the parent application window. |
| int | Returns the current y-coordinate screen position of this browser window relative to the parent application window. |
| jsx3.gui.Block | Returns the first DOM child of this window object. |
| String | getTitle() Returns the title of this window. |
| int | getWidth() Returns the inner (visible) width of this window. |
| int | Returns whether this window is "dependent. |
| boolean | isOpen() Returns whether the browser window of this window instance is open. |
| boolean | Returns whether the parent application window of this window instance is open. |
| int | Returns whether this window is resizable via user interaction. |
| int | Returns whether this window will show scroll bars if the content outgrows the window. |
| void | Moves the browser window of this window instance to a position on the screen. |
| boolean | open() Opens the browser window of this window instance. |
| String | repaint() Repaints the root block of this window. |
| void | setDependent(bDependent : boolean) Sets whether this window is "dependent. |
| void | Sets the inner (visible) height of this window. |
| void | setResizable(bResizable : boolean) Sets whether this window is resizable via user interaction. |
| void | setScrollable(bScrollable : boolean) Sets whether this window will show scroll bars if the content outgrows the window. |
| void | Sets the title of the window. |
| void | Sets the inner (visible) width of this window. |
| String | toString(strTitle : ?) |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
true if the window successfully closed or false if it didn't close
because of JavaScript security constraints or user interaction. this.close();), followed by a call to removeChild (e.g., this.getParent().removeChild(this);).jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.
true if the window is open.
true if the parent window is open.
setResizable() and therefore may not truly reflect the current state of the
browser window.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.
setScrollable() and therefore may not truly
reflect the current state of the browser window.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.
DID_OPEN event.true if the window successfully opened (probably). | Field Summary | |
|---|---|
| static String | The default background pattern
|
| static String | #c8c8d5 (default)
|
| static String | #ffffff (default)
|
| static String | solid 1px #e8e8f5;solid 0px;solid 1px #a8a8b5;solid 0px; (default)
|
| static String | solid 1px #9898a5;solid 1px #9898a5;solid 1px #9898a5;solid 1px #9898a5; (default)
|
| static int | 11 (default)
|
| static String | jsx3.gui.Block.FONTBOLD (default)
|
| static int | 26 (default)
|
| static int | 0 (default) |
| static int | 2 |
| static int | 3 |
| static int | 1 |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| int | getType() Returns the type of the window bar; one of: jsx3.gui.WindowBar.TYPECAPTION, jsx3.gui.WindowBar.TYPETOOL, jsx3.gui.WindowBar.TYPEMENU, jsx3.gui.WindowBar.TYPETASK |
| static String | Deprecated. |
| String | paint() Returns the DHTML, used for this object's on-screen VIEW |
| jsx3.gui.WindowBar | calls super method in Block but if bRepaint is true, then also repaints task bar |
| jsx3.gui.WindowBar | Returns the type of the window bar;
returns reference to self to facilitate method chaining; |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
true, the view of this object is immediately updated, obviating the need to call repaint().| Class Summary | |
|---|---|
| jsx3.html.BlockTag | Represents an HTML element that occupies a rectangle of the screen. |
| jsx3.html.DOM | Handles Provides methods to manipulate browser DOM nodes. |
| jsx3.html.FontTag | Represents an HTML element that defines font styles. |
| jsx3.html.Style | Handles Provides methods to manipulate browser DOM nodes. |
| jsx3.html.Tag | Represents an HTML element. |
| jsx3.html.Text | Represents an HTML text node. |
| Method Summary | |
|---|---|
| static void | Copies the given string of text to the clipboard |
| static jsx3.app.Model | Traverses the browser DOM up from objGUI and returns the first GI DOM node that contains
objGUI. |
| static void | getOuterHTML(objElement : HTMLElement) Returns the serialized HTML representation of objElement. |
| static void | loadImages(varImages : String... | jsx3.net.URI... | Array<String | jsx3.net.URI>) Pre-loads images into the HTML page so that they are available immediately when a control paints them. |
| static String | paste() Returns the current text content of the clipboard |
| static void | Replaces the children of objElement with a text node of value strText. |
| static void | Replaces objElement with an HTML snippet, strHTML. |
| Method Detail |
|---|
objGUI and returns the first GI DOM node that contains
objGUI.objElement.objElement with a text node of value strText.objElement with an HTML snippet, strHTML.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the bgcolor field. |
| Array<int> | Returns the dimensions in an array of four int values |
| int | Returns the height field. |
| int | getLeft() Returns the left field. |
| String | Returns the margin field, as set by setMargin(). |
| Array | parses the margin field into an array of four int values |
| String | Returns the padding field, as set by setPadding(). |
| Array | parses the padding field into an array of four int values |
| String | Returns the position field. |
| int | getTop() Returns the top field. |
| int | getWidth() Returns the width field. |
| int | Returns the zIndex field. |
| void | setBackgroundColor(bgcolor : String) Sets the bgcolor field. |
| void | Sets all four dimensions at once. |
| void | Sets the height field. |
| void | Sets the left field. |
| void | Sets the margin field, can be a single value or four values separated by space that correspond to top, right, bottom, and left. |
| void | setPadding(padding : String) Sets the padding field, can be a single value or four values separated by space that correspond to top, right, bottom, and left. |
| void | setPosition(position : String) Sets the position field, can be 'absolute' or 'relative'. |
| void | Sets the top field. |
| void | Sets the width field. |
| void | Sets the zIndex field. |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | init() instance initializer
|
| Method Summary | |
|---|---|
| static void | Clears a string of multiple CSS style properties to a DOM element; Provides a way for a string of CSS to be removed from the node |
| static int | getExtendedOffsetHeight(objNode : HTMLElement) Gets the true offset height for the element including: margin, padding, border, and content |
| static int | getExtendedOffsetWidth(objNode : HTMLElement) Gets the true offset width for the element including: margin, padding, border, and content |
| static void | Removes the function, objFn, as the event handler for the given DOM node. |
| static void | Applies a single CSS style to a DOM node |
| static void | Applies a string of multiple CSS style properties to a DOM element |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
left:10px;height:20px;width:100px; or left:;height:;width:;
| Method Summary | |
|---|---|
| String | getColor() Returns the color field. |
| String | Returns the fontFamily field. |
| String | Returns the fontsize field. |
| String | Returns the fontStyle field. |
| String | Returns the fontWeight field. |
| String | Returns the textAlign field. |
| String | Returns the textDecoration field. |
| void | Sets the color field. |
| void | setFontFamily(fontFamily : String) Sets the fontFamily field. |
| void | setFontSize(fontSize : int | String) Sets the fontsize field. |
| void | setFontStyle(fontStyle : String) Sets the fontStyle field. |
| void | setFontWeight(fontWeight : String) Sets the fontWeight field. |
| void | setTextAlign(textAlign : String) Sets the textAlign field. |
| void | setTextDecoration(textDecoration : String) Sets the textDecoration field. |
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | init() instance initializer
|
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | appendChild(child : jsx3.html.Tag) Sdds a child to the list of this tag's children; may be vetoed by onAppendChild(). |
| Array<jsx3.html.Tag> | Returns the children tags. |
| String | Returns the cssClass field. |
| String | Returns the cssClass field. |
| jsx3.html.Tag | getFirstChildOfType(type : String | Function) Returns the first child tag of type type. |
| String | getId() Returns the id field. |
| jsx3.html.Tag | Returns the parent tag. |
| String | getProperty(strName : String) Returns an attribute of this HTML element. |
| String | Returns a style of this HTML element. |
| String | getTagNS() Returns the namespace of this HTML element. |
| String | Returns the name of this HTML element, such as "table" or "div". |
| protected boolean | onAppendChild(child : jsx3.html.Tag) Called before appending a child. |
| protected boolean | onRemoveChild(child : jsx3.html.Tag) Called before removing a child. |
| String | paint() Serializes this HTML element to an HTML string using various overridable methods in this class. |
| HTMLElement | paintDom() Prepares this HTML element for insertion into the live browser DOM and returns the underlying native HTML element. |
| protected void | This method is called on each HTML tag before it is painted to screen. |
| void | release() Releases all bi-directional references between this instance and its children. |
| void | removeChild(child : jsx3.html.Tag) Removes a child from the list of this tag's children; may be vetoed by onRemoveChild(). |
| void | Removes all the children of this tag. |
| void | removeProperty(strName : String...) Removes any number of properties from this HTML element. |
| void | removeStyle(strName : String...) Removes any number of styles from this HTML element. |
| void | Replaces a child of this tag. |
| void | setClassName(cssClass : String) Sets the cssClass field, the HTML 'class' attribute. |
| void | setClassName(cssClass : String) Sets the cssClass field, the HTML 'class' attribute. |
| void | setExtraStyles(extraStyles : String) Sets the extraStyles field, this string is prepended as-is to the generated value for the style attribute of the tag. |
| void | Sets the id field. |
| void | Sets an attribute of this HTML element. |
| void | Sets a style of this HTML element. |
| String | toString() |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
onAppendChild().
type.true to allow the append, false to veto. true to allow the removal, false to veto. jsxsuper().onRemoveChild().tag.setProperty(n1, p1, n2, p2);.null, the attribute is removed.
tag.setStyle(n1, s1, n2, s2);.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Field Summary | |
|---|---|
| static jsx3.app.Server | The server instance corresponding to the application opened in the IDE. |
| Method Summary | |
|---|---|
| static jsx3.app.Server | Returns the server instance corresponding to the currently active component editor tab. |
| static Array<jsx3.app.Model> | getSelected(bIncludeBody : boolean) Returns the collection of DOM objects currently selected in the Component Hierarchy palette. |
| static void | Loads a template catalog for the Properties Editor, Events Editor, or XSL Parameters palettes. |
| static void | Registers a template for a particular class in the Properties Editor, Events Editor, or XSL Parameters palettes. |
| Field Detail |
|---|
| Method Detail |
|---|
null.prop, event, or xsl.function(objJSX : jsx3.app.Model) : jsx3.xml.Documentjsx3 namespace.
| Class Summary | |
|---|---|
| jsx3.lang.AOP | Simple aspect oriented programming for General Interface. |
| jsx3.lang.Class | JavaScript class that allows introspection of the JSX class hierarchy. |
| jsx3.lang.ClassLoader | The class loader initializes the system and loads applications and add-ins. |
| jsx3.lang.Exception | The base GI exception class. |
| jsx3.lang.IllegalArgumentException | A special exception type to throw when the caller of a function does not pass arguments according to the method's
contract. |
| jsx3.lang.Method | JSX Class extends the build in JavaScript class Function. |
| jsx3.lang.NativeError | Wraps the browser-native exception object (what might be caught in a typical try/catch/finally block). |
| jsx3.lang.Object | Base class for all classes defined with jsx3.lang.Class. |
| jsx3.lang.Package | The Package class provides an introspectable API for JavaScript/JSX packages. |
| jsx3.lang.System | A collection of GI system related functions. |
| Method Summary | |
|---|---|
| static Function | |
| static Array<Function> | |
| Method Detail |
|---|
jsx3.AOP.pc("myPointcut", {classes:"jsx3.xml.Document", methods:"load"});
jsx3.AOP.before("myPointcut", function(strURL, intTimeout) {
jsx3.log("load() called on " + this + " with URL " + strURL + ".");
});
jsx3.AOP.after("myPointcut", function(rv, strURL, intTimeout) {
jsx3.log("load() called on " + this + " with URL " + strURL + " returned " + rv + ".");
});
jsx3.AOP.around("myPointcut", function(aop, strURL, intTimeout) {
var t1 = new Date().getTime();
var rv = aop.proceed(strURL, intTimeout);
var tTotal = new Date().getTime() - t1;
jsx3.log("load() called on " + this + " with URL " + strURL + " took " + tTotal + " ms and returned " + rv + ".");
return rv;
});
Note that after advice receives the method return value as the first method parameter. Note also that around
advice must manage the AOP chain by calling proceed() on the first method parameter and by returning
the return value of this call. | Method Summary | |
|---|---|
| static void | |
| static void | |
| static void | |
| static void | Creates a new pointcut. |
| static void | Removes a pointcut. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
true, remove this advice.
true, remove this advice.
true, remove this advice.
\w+.instanceOf(type).jsx3.lang.Class in one of the following ways:
defineClass and
defineInterface to define a class in the JSX class hierarchy. Note that any class defined
in the package jsx3.lang is aliased into the jsx3 package. Therefore
jsx3.lang.Object may also be referenced as jsx3.Object.
The following are class nomenclature definitions using jsx3.lang.Object as an example:
Object
Function
jsx3.lang.Class
Object
jsx3.lang.Class.defineClass(
"eg.Example", // the full name of the class to create
eg.Base, // the class extends eg.Base
[eg.Comparable, eg.Testable], // the class implements interfaces eg.Comparable and eg.Testable
function(Example) { // name the argument of this function "Example"
// every class must define an init method since it is called automatically by the constructor
Example.prototype.init = function(arg1) {
this.arg1 = arg1;
};
// define an instance method like this:
Example.prototype.instanceMethod = function() {
...
};
// define an abstract method like this:
Example.prototype.abstractMethod = jsx3.Method.newAbstract();
// define a static method like this:
Example.staticMethod = function() {
...
};
// define a static field like this:
Example.STATIC_FIELD = "...";
// define an instance field like this:
Example.prototype.instanceField = "...";
}
);
| Method Summary | |
|---|---|
| void | Adds an after advice function to a method of this class via AOP. |
| jsx3.lang.Object | Creates a new instance of this class and populates its properties with the properties of the
obj parameter. |
| static void | defineClass(strName : String, objExtends : Function | jsx3.lang.Class, arrImplements : Array<jsx3.lang.Class | Function | String>, fctBody : Function) Defines a new class in the JSX hierarchy. |
| static void | Defines a new interface in the JSX hierarchy. |
| static jsx3.lang.Class | Retrieve an instance of jsx3.Class for a fully-qualified class name. |
| Array<jsx3.lang.Class> | Returns an array of all the classes defined in this class. |
| Function | Returns the constructor function of this class. |
| jsx3.lang.Method | Returns the accessor (getter) method of this class's bean property strProp. |
| Array<jsx3.lang.Class> | Returns the array of classes and interfaces that this class inherits from, ordered by
precedence from highest to lowest. |
| Array<String> | Returns the array of instance fields defined for this class. |
| jsx3.lang.Method | getInstanceMethod(strMethodName : String) Returns the instance method defined in this class with name strMethodName. |
| Array<jsx3.lang.Method> | Returns the array of instance methods defined for this class. |
| Array<jsx3.lang.Class> | Returns the array of interfaces that this class was defined to implement. |
| String | getName() Returns the fully-qualified name of this class. |
| jsx3.lang.Package | Returns the package of this class. |
| String | Returns the package name of this class, e.g. |
| jsx3.lang.Method | Returns the mutator (setter) method of this class's bean property strProp. |
| Array<String> | Returns the array of static fields defined for this class. |
| jsx3.lang.Method | getStaticMethod(strMethodName : String) Returns the static method defined in this class with name strMethodName. |
| Array<jsx3.lang.Method> | Returns the array of static methods defined for this class. |
| jsx3.lang.Class | Returns the super class of this class. |
| boolean | isAssignableFrom(objClass : jsx3.lang.Class) Determines whether this class is the same as or is a superclass or superinterface
of parameter objClass. |
| boolean | isInstance(obj : Object) Determines whether an object is an instance of this class. |
| boolean | Returns whether this class was defined as an interface. |
| void | Copies all the instance methods in this class into an instance (of another class). |
| jsx3.lang.Object | newInnerClass(arg : Object...) Creates a new instance of this class so that it can be used to create a java-style inner
class extending this class. |
| Object | newInstance(arg : Object...) Creates a new instance of this class by invoking the class constructor. |
| String | toString() |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Method Detail |
|---|
objClass.strMethod is called. obj parameter. Does not call init() when instantiating the class.
obj
into the newly created object.jsx3.lang.Class that represents an interface
defineInterface). May also be null or empty.null. If provided and representing an introspectable class, must be an interface rather
than a class.jsx3.Object. Thus the name of the class returned by this method may not always equal the value
of the strName parameter.
jsx3.Class.defineClass("eg.ContainingClass", null, null, function(){});
jsx3.Class.defineClass("eg.ContainingClass.InnerClass", null, null, function(){});
strProp. Searches this class and
the classes that it inherits method from
for an instance method named "getStrProp" or "isStrProp" using the strProp parameter with the first
letter made uppercase.strMethodName.strMethodName
jsx3.lang.Package.definePackage.jsx3.lang. If the package containing this class has
been defined, then this method returns the name of the package. Otherwise, it returns the fully-qualified name
of this class less the final token.strProp. Searches this class and
the classes that it inherits method from
for an instance method named "setStrProp" using the strProp parameter with the first
letter made uppercase.strMethodName.strMethodName
jsx3.lang.Object.objClass.obj is null.
objinit() method will be called. In this way you can accomplish the following:
var aClass = eg.Testable.jsxclass; // get jsx3.lang.Class instance
var innerClass = aClass.newInnerClass(); // create inner class instance
innerClass.test = function() {}; // implement the eg.Testable interface
innerClass instanceof eg.Testable; // evaluates to true
new() on this class's constructor function and will call the class's init() method.jsx3.CLASS_LOADER) is created when the system loads.
The following deployment parameters affect the behavior of the class loader:
jsx_no_messages - if set the class loader does not load the
jsx:/locale/messages.xml properties bundle.jsx_no_locale - if set the class loader does not load the
jsx:/locale/locale.xml properties bundle.jsx_logger_config - the relative path to the logging system configuration file. If not set,
jsx:/../logger.xml is used.jsx_browsers - overrides the default set of supported browsers. The format of this parameter
is
bt={allow,warn}[,...] where bt is the browser type returned by the
getType() method.| Field Summary | |
|---|---|
| static int | |
| static int | |
| Method Summary | |
|---|---|
| String | getType() Returns the browser type as determined by the class loader. |
| jsx3.util.Job | loadAddin(objAddin : String | jsx3.app.AddIn) |
| jsx3.util.Job | |
| void | Loads a GI class synchronously. |
| boolean | loadJSFileSync(strURI : String) Loads a JavaScript file synchronously. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From Object |
|---|
| toString |
| Field Detail |
|---|
| Method Detail |
|---|
ie6 - Microsoft Internet Explorer versions 6.xie7 - Microsoft Internet Explorer versions 7.xie8 - Microsoft Internet Explorer versions 8.xie9 - Microsoft Internet Explorer all versions above 8.xie - Microsoft Internet Explorer earlier or unrecognized versionfx1_5 - Mozilla Firefox versions 1.5.xfx2 - Mozilla Firefox versions 2.xfx3 - Mozilla Firefox versions 3.xfx4 - Mozilla Firefox all versions above 3.xfx - Mozilla Firefox earlier or unrecognized versionsf3 - Apple Safari versions 3.xsf4 - Apple Safari all versions above 3.xsf - Apple Safari earlier or unrecognized versiongc1 - Google Chrome, any versionop9 - Opera versions 9.xop10 - Opera all versions above 9.xop - Opera earlier or unrecognized versiongk - other Gecko-based browserxx - unrecognized browsertrue if the file was loaded successfully.
// throwing a simple exception:
throw new jsx3.Exception("an error occurred");
// throwing a nested exception:
try {
...
} catch (e) {
throw new jsx3.Exception("an error occurred while ...",
jsx3.NativeError.wrap(e));
}
// catching an exception and logging it
try {
...
} catch (e) {
jsx3.util.Logger.GLOBAL.error("an error occurred while ...",
jsx3.NativeError.wrap(e));
}
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| jsx3.lang.Exception | getCause() Returns the cause of this exception, if one was specified in the constructor. |
| String | Returns the description of this exception, as specified when the constructor was called. |
| Array<Function> | getStack() Returns the complete call stack from when this exception was instantiated as an array of functions. |
| String | Returns a string representation of the call stack for when this exception was instantiated. |
| String | toString() Returns a string representation of this exception. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
init() method.| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Methods Inherited From jsx3.lang.Exception |
|---|
| getCause, getMessage, getStack, printStackTrace, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Summary | |
|---|---|
| Object | undefined | Calls apply on the native function. |
| Object | undefined | Calls call on the native function. |
| int | getArity() Returns the number of parameters that this method takes (as declared in the JavaScript source). |
| jsx3.lang.Class | jsx3.lang.Package | Returns the class that defined this method. |
| Function | Returns the native JavaScript function of this method. |
| String | getName() Returns the name of the method. |
| String | getParameterName(intIndex : int) Returns the name of a parameter that this method takes (as declared in the JavaScript source). |
| Array<String> | Returns the names of parameters that this method takes (as declared in the JavaScript source). |
| boolean | Returns true if this method is abstract. |
| boolean | Returns whether the definer of this class (returned by getDeclaringClass()) is in fact
a package. |
| boolean | isStatic() Returns true if this method is static (is a class method). |
| static Function | newAbstract(paramNames : String...) Creates a new abstract method. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
Function.apply()Function.apply()Function.call(), supports up to 11 arguments (this+10)getDeclaringClass()) is in fact
a package.jsx3.lang.Exception:
try {
tryIt(); // code that may throw a native error (null-pointer, etc)
// or an instance of jsx3.Exception
} catch (e) {
e = jsx3.NativeError.wrap(e);
// now e is guaranteed to be an instance of jsx3.Exception
window.alert(e.printStackTrace());
}
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Returns the URL of the JavaScript include where this error was raised. |
| int | Returns the line number in the JavaScript include where this error was raised. |
| String | Returns the native message for this error. |
| String | getName() Returns the native browser name for this error. |
| static void | initErrorCapture(fctTrap : Function) Initializes the error trapping mechanism. |
| boolean | Deprecated. |
| String | toString() Returns the native error as a human-readable string. |
| static jsx3.lang.Exception | wrap(objError : jsx3.lang.Exception | Object) Wraps a native browser exception in an instance of NativeError. |
| Methods Inherited From jsx3.lang.Exception |
|---|
| getCause, getStack, printStackTrace |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
objException is not a native browser error. Use
NativeError.wrap() if the type of caught object is unknown.| Method Detail |
|---|
NativeError. This method also accepts
an argument of type jsx3.Exception, in which case it will just return the argument. This method wraps
any other type of argument by converting it to a string and and creating a new jsx3.Exception with that message.jsx3.lang.Class.
jsx3.lang.Object defines the method
getClass(), which returns an instance of jsx3.lang.Class. This method is useful for
testing whether an object is an instance of exactly (not a superclass of) a class.instanceof: obj instanceof jsx3.lang.Object. Note that the right hand argument of this
expression must be the constructor function of a class and not of an interface defined with
jsx3.Class.defineInterface()).instanceOf() defined in
jsx3.lang.Object. This method will check against all classes and interfaces but is probably slower
than the instanceof operator.
var doc = new jsx3.gui.Block();
doc.getClass().equals(jsx3.gui.Block.jsxclass); // true
doc.getClass().equals(jsx3.app.Model.jsxclass); // false, even though Block extends Model
doc instanceof jsx3.gui.Block; // true
doc instanceof jsx3.app.Model; // true
doc instanceof jsx3.util.EventDispatcher; // false, EventDispatcher is an interface
doc instanceof Object; // true, works on non-jsx3.Class class constructors
doc.instanceOf(jsx3.gui.Block); // true
doc.instanceOf(jsx3.app.Model.jsxclass); // true, accepts arguments of type jsx3.Class
doc.instanceOf('jsx3.lang.Object'); // true, accepts arguments of type String
doc.instanceOf(jsx3.util.EventDispatcher); // true, works on interfaces
doc.instanceOf(Object); // true, works on non-jsx3.Class class constructors
| Constructor Summary | |
|---|---|
| void | init() Instance initializer. |
| Method Summary | |
|---|---|
| jsx3.lang.Object | clone() Returns a shallow copy of this object. |
| boolean | Returns true if this object is equals to the obj parameter. |
| Object | Eval a string of code with a particular this and local variable stack context. |
| jsx3.lang.Class | getClass() Returns the class of this object. |
| String | Deprecated. use Object.getClass()
|
| String | Deprecated. use Object.getClass().getName() and parse out final token
|
| String | Deprecated. use Object.getClass().getPackageName()
|
| boolean | instanceOf(objClass : Function | jsx3.lang.Class | String) Determines whether this object is an instance of objClass, that is, whether
objClass is equal to or a superclass or superinterface of this object's class. |
| boolean | Deprecated. use instanceof or Object.instanceOf()
|
| boolean | isSubclassOf(strClassName : String) Deprecated. no direct replacement
|
| void | Deprecated. No-op, replaced with jsx3.lang.AOP. |
| protected Object | undefined | Calls the supermethod overridden by the method that calls jsxsuper(). |
| protected Object | undefined | jsxsupermix(arg : Object...) Like jsxsuper() but traverses up through all the interfaces implemented by this class and its super classes. |
| void | setInstanceOf(strInstanceOf : String) Deprecated. no direct replacement
|
| String | toString() |
| Constructor Detail |
|---|
| Method Detail |
|---|
obj parameter.Object.getClass().getName() and parse out final token
Object.getClass().getPackageName()
objClass, that is, whether
objClass is equal to or a superclass or superinterface of this object's class.objClass is a string that is not the name of a registered class
instanceof or Object.instanceOf()
jsx3.lang.AOP.
Subclass.prototype.init = function(a, b, c) {
this.jsxsuper(a, b); // calls the init() method in the superclass of Subclass
this.c = c;
};
jsx3.lang.Class.defineClass()/defineInterface(), or if no suitable super method exists
// imagine that the jsx3.Testable mixin interface defines a method test() that provides basic testing functionality
jsx3.Class.defineClass('eg.Test', null, [jsx3.Testable], function(Test){
Test.prototype.test = function() {
this.setUpTest(); // do something before running the test
this.jsxsupermix(); // calls test() in jsx3.Testable
this.tearDownTest(); // do something after running the test
};
});
jsx3.lang.Class.defineClass()/defineInterface(), or if no suitable super method existsjsx3.lang is known as the package "namespace," which is a plain
JavaScript object and is analogous to the constructor property of a jsx3.Class.
The following is an example of how to define a new package called eg.tests:
jsx3.lang.Package.definePackage(
"eg.tests", // the full name of the package to create
function(tests) { // name the argument of this function "eg"
// define a static method like this:
tests.staticMethod = function() {
...
};
// define a static field like this:
tests.STATIC_FIELD = "...";
}
);
| Method Summary | |
|---|---|
| static void | Defines a new package so that it is available for introspection. |
| static jsx3.lang.Package | Returns the defined package with name equal to strName. |
| Array<jsx3.lang.Class> | Returns an array of all the classes defined in this package. |
| String | getName() Returns the fully-qualified name of this class. |
| Object | Returns the namespace of this package. |
| static Array<jsx3.lang.Package> | Returns a list of all defined packages. |
| Array<String> | Returns the array of static fields defined for this package. |
| jsx3.lang.Method | getStaticMethod(strMethodName : String) Returns the static method defined in this package with name strMethodName. |
| Array<jsx3.lang.Method> | Returns the array of static methods defined for this package. |
| String | toString() |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Method Detail |
|---|
fctBody are simply added to the pre-existing namespace. Then, all members, whether defined
before the call to this method or with the call to this method, are made introspectable.
This method may be called more than once with the same strName without causing an error. The
package is simply redefined. Only the members that are defined in the namespace object after the last call to
this method will be available for introspection.
It is an error if, after fctBody is executed, any two members of the namespace object equal the
same function object. This is know as method aliasing, which can be a useful technique in JavaScript. Any
method aliasing within the namespace object must occur after the call to this method. Therefore, method aliasing
will cause an error if this package is redefined later.
strName.null if none matches
jsxpackage.strMethodName.strMethodName
| Method Summary | |
|---|---|
| static void | If the locale has been explicitly set with setLocale(), that locale is returned. |
| static String | |
| static String | getProperty(strKey : String) Returns a system property as specified by a JSS file loaded by the JSX runtime or an addin. |
| static String | Returns the version number of General Interface. |
| static void | |
| static void | setLocale(objLocale : ?) Sets the system-wide locale. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
setLocale(), that locale is returned. Otherwise the
locale is determined by introspecting the browser. If all else fails the default locale, en_US, is returned.
"3.1.0", etc.
| Class Summary | |
|---|---|
| jsx3.net.Form | Provides support for legacy HTML GET and POST forms. |
| jsx3.net.Request | A generic wrapper to hide the complexities and API-specifics of the native XMLHTTP control for a given browser. |
| jsx3.net.Service | This class is used in conjunction with the XML Mapping Utility to provide transactional support for those services using XML-based messaging. |
| jsx3.net.URI | Represents a Uniform Resource Identifier (URI) reference. |
| jsx3.net.URIResolver | An interface specifying the methods necessary to define a context against which URIs are resolved. |
promptForFile()) is only supported in
Microsoft Internet Explorer.
| Field Summary | |
|---|---|
| static String | Event type published when a file has been chosen through user interaction. |
| static String | Event type published when a security error occurs trying to access the response. |
| static String | Event type published when the response has loaded. |
| static String | Event type published when the response is still not ready after the specified timeout period. |
| static String | |
| static String | |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| void | abort() Stops polling for a response. |
| void | addFileUploadField(strName : String) Adds a file upload field to this form. |
| void | conceal() Hides the IFRAME containing this form after it has been shown by calling reveal(). |
| void | destroy() Destroys the form and the hidden IFRAME. |
| String | Returns the action of this form, the URL that this form is submitted to. |
| String | Returns the value of a field in this form. |
| Array<String> | Returns the names of all fields in this form. |
| String | Returns the method of this form. |
| boolean | Returns whether this form is multipart. |
| String | Returns the content of the response as a string. |
| jsx3.xml.Document | Returns the content of the response as an XML document. |
| static jsx3.net.Form | newFromFragment(strFragment : String) Creates a new form and initialize it from the HTML representation of a form. |
| void | promptForFile(strFieldName : String) Invokes the operating system file browser to choose a file for a file upload field. |
| void | removeField(strName : String) Removes a field from this form. |
| void | Reveals the IFRAME containing this form for debugging purposes. |
| void | Sends the form. |
| void | Sets the action of this form. |
| void | Sets the value of a field in this form. |
| void | Sets the method of this form. |
| void | setMultipart(multipart : boolean) Sets whether this form is multipart. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
reveal().null if no such field exists.
METHOD_GET or METHOD_POST.
\r\n or \n depending on the platform.
Setting the value to null will set it to the empty string.
" " + strValue to the existing value. The space is
only inserted if the existing value is not empty.
METHOD_GET or METHOD_POST.
objRequest.setRequestHeader("Content-Type", "text/xml");
| Field Summary | |
|---|---|
| static String | Event type published when the response has loaded. |
| static String | Event type published when the server has not responded after the specified timeout period. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| jsx3.net.Request | abort() Aborts the request. |
| static void | Adds a handler that will field requests to a particular URL scheme. |
| static void | cancelRequest(strRequestId : String) Deprecated. Use abort() instead. |
| String | Gets the value of all the HTTP headers. |
| XMLHttpRequest | Deprecated. |
| int | Deprecated. This method is not consistent between browsers. Use the event publisher interface instead to track
the state of the request.
|
| static jsx3.net.Request | getRequest(strRequestId : String) Deprecated. Static access to pending requests by id is deprecated.
|
| String | getResponseHeader(strName : String) Gets the value of a specific HTTP response header. |
| String | Gets the content of the response as string. |
| jsx3.xml.Document | Gets the content of the response as an XML document. |
| int | Gets the HTTP response code (e.g. |
| String | Gets the HTTP response line status (e.g. |
| String | getURL() Gets the URL passed when opening this request. |
| static String | Deprecated. |
| static void | Creates and opens a request object. |
| jsx3.net.Request | open(strMethod : String, strURL : String | jsx3.net.URI, bAsync : boolean, strUser : String, strPass : String) Initializes the request, and specifies the method, URL, and authentication information for the request. |
| jsx3.net.Request | Sends the request. |
| jsx3.net.Request | Sets the value of a specific HTTP request header. |
| jsx3.net.Request | setTimeouts(intResolveTimeout : int, intConnectTimeout : int, intSendTimeout : int, intReceiveTimeout : int) Deprecated. IE only.
|
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
abort() instead.null is returned.Request based on the scheme of strURL.jsx3.net.Request.EVENT_ON_TIMEOUT event to
be notified of a timeout.open() method should be called before calling
this method.| Field Summary | |
|---|---|
| static String | event type for unsuccessful response |
| static String | Event type published each time a rule with one or more restrictions fails during message generation. |
| static String | Event type published each time a mapping rule is used to create a node, locate a node, or map to a node. |
| static String | event type for successful response |
| static String | Event type published when the response is still not ready after the specified timeout period. |
| static String | XML namespace for JSON objects when converted to XML |
| Constructor Summary | |
|---|---|
| void | init(strRulesURL : String, strOperationName : String, strOutboundURL : String, strInboundURL : String) instance initializer |
| Method Summary | |
|---|---|
| static jsx3.xml.Document | Converts a JSON object to an XML document belonging to the namespace URI, http://xsd.tns.tibco.com/gi/json/2007/. |
| static String | null | XML2JSON(objXML : jsx3.xml.Document) Converts an XML document belonging to the namespace URI, http://xsd.tns.tibco.com/gi/json/2007/, into a serialized JSON String. |
| void | Deprecated. Renamed to setRequestHeader. |
| jsx3.xml.Document | compile() Compiles the CXF rules for this service instance to an equivalent XSLT document. |
| boolean | Generates the request message (if applicable) and sends to the remote service. |
| void | Applies all inbound mappings, using the server response document as the source for the operation. |
| void | Provides a method to manually trigger the response chain by initiating the response event for the instance. |
| String | Gets the URL for the service endpoint where the request will be sent |
| jsx3.xml.Document | Call this method after the service has responded to get a parsed instance of the server's XML response |
| String | Gets the URL for a "typical", XML-formatted server resonse document. |
| boolean | getJSONP() If true, the Script transport will use JSONP |
| String | Gets the method for the request. |
| jsx3.Boolean | getMode() Gets the mode (static jsx3.Boolean.FALSE or live jsx3.Boolean.TRUE). |
| String | Gets the namespace for the server/project to run the service instance within. |
| void | Deprecated. Renamed to getOperationName. |
| String | Gets the name of the operation to use within a multi-operation rules file. |
| jsx3.xml.Document | Call this method after 'doCall' has been called to get a parsed instance of the request document--what was actually sent to the remote service |
| String | Gets XPath address for the node in the outbound stub document to which to append the generated message. |
| String | null | Gets URL for the base stub to use for the request message (the XML document to contain the generated document) |
| String | Gets URL for a 'typical' XML-formatted request document to send to the server; when this is set, the mapper does not even attempt to generate a document. |
| jsx3.net.Request | Gets the jsx3.net.HttpRequest instance that performs the transaction with the remote service (the transport object for the message). |
| String | Gets the URL for the rules file to use (a CXF document). |
| jsx3.xml.Document | Returns the rules document used by the Service instance (a CXF document) |
| jsx3.app.Server | Returns the server that this service runs in, as set by the setNamespace() method. |
| jsx3.xml.Document | Gets the request message specific to the MESSAGETYPE (input, output, fault). |
| int | Gets the HTTP response code (i.e. |
| void | Deprecated. Renamed to getOutboundStubURL. |
| String | Returns a CR-LF delimited list of supported namespaces and thei related prefix (as defined by the Object, jsx3.net.Service. |
| String | Gets user name to send as part of the http request (for servers requiring http authentication) |
| String | Gets password to send as part of the http request (for servers requiring http authentication) |
| static void | Deprecated. |
| jsx3.xml.Document | getWSDL() Deprecated. The WSDL is no longer relevant to the Service class as the rules file will contain all information necessary to generate and process the Service interaction.
|
| jsx3.net.Service | Resets the rules tree to default state (with all 'skip' flags removed) from those rules that were skipped during the previous transaction |
| jsx3.net.Service | Dereferences the parsed rules tree (a jsx3.xml.Document instance) managed by this Service instance, forcing a reload of the document from disk the next time the rules document is requested |
| jsx3.net.Service | setEndpointURL(strAlternateURL : String) Sets the URL for the service endpoint where the request will be sent. |
| void | setInboundDocument(objXML : jsx3.xml.Document) Sets a parsed instance of the response document as soon as it returns from the server returned from the service; otherwise null |
| jsx3.net.Service | setInboundURL(strInboundURL : String) Sets the URL for a "typical", XML-formatted server resonse document. |
| void | If set to true, the service class will append an additional parameter to the URL in the form, callback={method}, where
{method} is a temporary callback function managed by the Service instance. |
| void | Sets the method for the request different than the one described in the rules file. |
| void | setMode(MODE : jsx3.Boolean) Sets the mode (static jsx3.Boolean.FALSE or live jsx3.Boolean.TRUE). |
| jsx3.net.Service | setNamespace(namespace : jsx3.app.Server | String) Sets the namespace for the server/project to run the service instance within. |
| jsx3.net.Service | setOnError(vntItem : String | Object | Function) Deprecated. Use jsx3.EventDispatcher interface instead with event type jsx3.net.Service.ON_ERROR.
|
| jsx3.net.Service | setOnSuccess(vntItem : String | Object | Function) Deprecated. Use jsx3.EventDispatcher interface instead with event type jsx3.net.Service.ON_SUCCESS.
|
| void | Deprecated. Renamed to setOperationName. |
| jsx3.net.Service | setOperationName(strOperationName : String) Sets the name of the operation to use within a multi-operation rules file. |
| jsx3.net.Service | setOutboundStubDocument(objDocument : jsx3.xml.Document) Sets the document that will serve as the container for the message generated by doCall and/or getServiceMessage. |
| jsx3.net.Service | setOutboundStubPath(strPath : String) Sets XPath address for the node in the outbound stub document to which to append the generated message. |
| jsx3.net.Service | setOutboundStubURL(strURL : String) Sets the URL to the document that will serve as the container for the message generated by doCall and/or getServiceMessage. |
| jsx3.net.Service | setOutboundURL(strOutboundURL : String) Sets the URL for a static XML-formatted request document to send to the Service. |
| void | Sets an HTTP Request header on the request. |
| jsx3.net.Service | setRulesURL(strRulesURL : String) Sets the URL for the rules file to use (a CXF document). |
| void | Deprecated. Renamed to setEndpointURL. |
| void | Sets the HTTP response code (i.e. |
| void | Deprecated. Renamed to setOutboundStubURL. |
| jsx3.net.Service | setTimeout(intTimeout : int, objHandler : Object | String | function, objFunction : function | String) Specifies how long to wait for the service to respond before cancelling the call. |
| jsx3.net.Service | setTimeouts(intResolveTimeout : int, intConnectTimeout : int, intSendTimeout : int, intReceiveTimeout : int) Deprecated. Due to browser security constraints, this method is no longer used. Use setTimeout instead. This method no longer affects any aspect of the Service call.
|
| jsx3.net.Service | setUserName(strName : String) Sets the user name to send with the posting (for those sites requiring http authentication) |
| jsx3.net.Service | setUserPass(strPass : String) Sets the password to send with the posting (for those sites requiring http authentication) |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
Create Node, Map to Cache, Invalidate Node, etc.this.eval(setValue(2));
6 would signify a 'Trace' level event.| Constructor Detail |
|---|
loadResource
method on the context server (jsx3.app.Server) instance. This ensures proper URL resolution while also establishing the
appropriate server context.| Method Detail |
|---|
http://xsd.tns.tibco.com/gi/json/2007/.
This document can then be converted back to the same JSON format by calling the complimentary method, XML2JSON.http://xsd.tns.tibco.com/gi/json/2007/, into a serialized JSON String.
This String, when evaluated, can then be converted back to the original document format by calling the complimentary method, JSON2XML.CDF Document, CDF Record, and CDF Attribute. Only one CDF Document
can be declared per Operation. Otherwise the compilation will fail.
All other mapping types will be ignored and will not be converted into an XSLT equivalent. Also note
that the order of a set of sibling mapping rules does not proscribe proper processing by way of
sequence. This means that any order of sibling mapping rules will result in appropriate processing, regardless of the
sibling node order returned from the given service. This facilitates nested record structures in that
attributes can first be applied to a given record before child elements (e.g., a 'record') are added.
Stated otherwise, any rule that has a descendant rule that would created a nested 'record' node should follow
all sibling mapping rules that would create an 'attribute' entity. Call this method immediately before/after doCall
for best performance.objEvent. Based upon the properties contained by this object, the response will be handled
differently by the response handler. The named properties are as follows:
getResponseXML
(to handle XML-formatted responses) or getResponseText (to handle JSON-formatted responses). If the event object does not
expose the 'target' property and/or if the 'target' does not expose the methods getResponseText or getResponseXML, it is assumed that objEvent
is a JSON object--the response itself. target; or JSON object
jsx3.Boolean.FALSE or live jsx3.Boolean.TRUE).setNamespace() method.setOutboundStubURL or setOutboundStubDocument in conjunction with setOutboundStubPath
are preferred to passing this parameter, since they provide much greater control. Also note that this value is stored statically in the rules document when the rules document is first created via the XML Mapping Utility.jsxapp://test/xml/typical.xml,
and xml/typical.xml, and JSXAPPS/test/xml/typical.xmlcallback={method}, where
{method} is a temporary callback function managed by the Service instance. This allows for flexibility when using
JSON Services that are also available as JSONP Services, in that the same URL can be used (setEndpointURL) but different
behaviors can be implemented. If the given JSONP Service uses a callback name different than "callback", pass the parameter
name expected by the given JSON Service. You may also implement a callback of your own by directly modifying the endpoint URL to call the named function of your
choosing. In such situations, pass false to this method, so the transport will not attempt any form
of callback. If you do choose to implement your own callback handlers, you must manually conclude the service call with a call to doRespond.jsx3.Boolean.FALSE or live jsx3.Boolean.TRUE). Overrides the default setting for the context Server
instance within which this Service instnace is running. (NOTE: This setting is accessible at the server level via the Project Settings dialog.)
Setting this value to jsx3.Boolean.FALSE, forces a test document
to be used to simulate a "typical" server response, instead of actually sending a request to a remote service. This is useful when setting up
test environments as well as providing "live" interactions when the remote server may not be available.jsx3.EventDispatcher interface instead with event type jsx3.net.Service.ON_ERROR.
jsx3.EventDispatcher interface instead with event type jsx3.net.Service.ON_SUCCESS.
doCall and/or getServiceMessage.
This is a useful way to dynamically assemble documents by chaining multiple service instances, using the output from one service as the input to another.
For example, when a SOAP Envelope requires both a SOAP Header as well as a SOAP Body, this method allows the Envelope to be assembled via a
two-step process of first adding mapped content to the Body, followed by a call to add mapped content to the Header.
Note that this method takes precedence over the static stub document url referenced in the rules file as well as
any call to setOutboundStubURL. Use this method in conjunction with setOutboundStubPath to
point to the specific location in the document where the generated message should be appended./SOAP-ENV:Envelope/SOAP-ENV:BodydoCall and/or getServiceMessage.
Overrides the static setting stored in the rules file. Use this method in conjunction with setOutboundStubPath to
point to the specific location in the document where the generated message should be appended.jsxapp://test/xml/typical.xml, and xml/typical.xml, and JSXAPPS/test/xml/typical.xmljsxapp://test/xml/typical.xml, and xml/typical.xml,
and JSXAPPS/test/xml/typical.xmljsx3.net.Request) returned by the method, [service_instance].getRequest(). However, calling this method will override
normal operation by forcing a valid/invalid state that affects methdods relying on the HTTP status
such as doInboundMap. This is particularly useful for SOAP services that provide alternate processing
instructions and mappings when a Fault occurs as well as when running tests in Static mode.java.net.URI.| Constructor Summary | |
|---|---|
| void | Instance initializer. |
| Method Summary | |
|---|---|
| boolean | equals(obj : ?) |
| static jsx3.net.URI | fromParts(scheme : String, userInfo : String, host : String, port : int, path : String, query : String, fragment : String) This method can be called with either 3 or 7 arguments. |
| String | |
| String | |
| String | getHost() |
| String | getPath() |
| int | getPort() |
| String | getQuery() |
| String | boolean | getQueryParam(strParam : String) Searches the query part for the value of a parameter. |
| Object<String, String> | |
| String | |
| String | |
| String | |
| boolean | |
| boolean | isOpaque() |
| jsx3.net.URI | Normalizes this URI's path. |
| jsx3.net.URI | relativize(uri : String | jsx3.net.URI) Relativizes the given URI against this URI. |
| jsx3.net.URI | resolve(uri : String | jsx3.net.URI) Resolves the given URI against this URI. |
| String | toString() |
| static jsx3.net.URI | valueOf(strURI : String | jsx3.net.URI) |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
URI.fromParts(scheme, schemeSpecificPath, fragment).
nullnull; or the scheme-specific part if called with 3 argumentsnull; or the URI fragment if called with 3 arguments, may be nullnullnullnullname1=value1&name2=value2&... If a parameter is specified without a following '='
this method will return boolean true.uri is opaque, or their schemes are not equal or their authorities are not
equal, uri is returned.uri and a path equal to:
uri is just "" or
"/", the path of uri
uri.| Field Summary | |
|---|---|
| static jsx3.net.URIResolver | The default URI resolver. |
| static jsx3.net.URIResolver | Resolves URIs according to the default resolver except that all relative URIs are
resolved relative to the JSX/ directory. |
| static jsx3.net.URIResolver | Resolves URIs according to the default resolver except that all relative URIs are
resolved relative to the user directory (or JSXAPPS/. |
| Method Summary | |
|---|---|
| static jsx3.net.URIResolver | getResolver(strURI : String | jsx3.net.URI) Returns the resolver explicitly referenced in the scheme, host, and path parts of the URI strURI. |
| abstract String | Returns the URI prefix that when prepended to relative URIs resolves them. |
| static boolean | isAbsoluteURI(strURI : String | jsx3.net.URI) Returns whether the URI strURI is considered absolute in the JSX system. |
| static void | |
| abstract jsx3.net.URI | Transforms a URI relative to the URL of the HTML page containing the JSX system into an absolute URI defined
in relation to this resolver. |
| abstract jsx3.net.URI | resolveURI(strURI : String | jsx3.net.URI) Resolves the URI strURI against the base context of this resolver. |
| Field Detail |
|---|
JSX/... –JSXAPPS/... –GI_Builder/... –jsx:/... –jsxapp://appPath/... –jsxaddin://addinKey/... –jsxuser:/... –JSX/ directory. This resolver resolves the following URIs to the same value:
JSX/file.xml
jsx:/file.xml
file.xml
JSXAPPS/../). This resolver resolves the following
URIs to the same value:
JSXAPPS/../file.xml
jsxuser:/file.xml
file.xml
| Method Detail |
|---|
strURI.
This method returns the the following values depending URI:
URIResolver.JSX.URIResolver capable of resolving URIs relative to the base
directory of the application corresponding to the host part of the URI.jsx3.app.AddIn corresponding to the host part of the URI. If
the addin is not loaded then null is returned.URIResolver.USER.URIResolver.DEFAULT.URIResolver.USER.URIResolver.DEFAULT.null."../" path segments. strURI is considered absolute in the JSX system. Implementors of the
URIResolver interface should always delegate resolution of absolute URIs to the default resolver.
This method is not equivalent to URI.isAbsolute() because, for example, URIs beginning with
"JSX/" are considered absolute in the JSX system.strURI.strURI against the base context of this resolver. Converts a URI relative to this
resolver into a URI relative to the URL of the HTML page containing the JSX system. Implementations of this
method should delegate to the default resolver any URIs that are judged to be absolute by the method
URIResolver.isAbsoluteURI().| Class Summary | |
|---|---|
| jsx3.util.Collection | Deprecated. Subsumed by jsx3.util.List. |
| jsx3.util.DateFormat | Formats and parses dates according to a token-based string format. |
| jsx3.util.Dojo | Provides the ability to load the Dojo JavaScript library. |
| jsx3.util.EventDispatcher | An Event Dispatcher mixin interface, adds the ability to register event listeners and dispatch events
to those listeners. |
| jsx3.util.GNode | |
| jsx3.util.Graph | |
| jsx3.util.Iterator | An interface that defines an object that can be iterated over. |
| jsx3.util.Job | |
| jsx3.util.JobGraph | |
| jsx3.util.List | An object-oriented version of the built-in JavaScript Array class. |
| jsx3.util.Locale | Represents a region of the world. |
| jsx3.util.Logger | A Logger is used to log messages about a particular component of an application. |
| jsx3.util.Logger.AlertHandler | Handles a logging record by sending it to a JavaScript alert. |
| jsx3.util.Logger.ConsoleHandler | Handles a logging record by sending it to the Firebug console. |
| jsx3.util.Logger.FormatHandler | A subclass of Handler that includes functionality for formatting logging records as human-readable
strings. |
| jsx3.util.Logger.Handler | The base logging handler class. |
| jsx3.util.Logger.Manager | Manager class for the logging system. |
| jsx3.util.Logger.MemoryHandler | A simple Handler class that stores a rotating cache of log records in memory. |
| jsx3.util.Logger.Record | Record bean that stores information about a logging message. |
| jsx3.util.MessageFormat | Constructs messages from a pattern and parameters. |
| jsx3.util.NumberFormat | Formats numbers. |
| Method Summary | |
|---|---|
| static int | Returns the array index of o in a. |
| static boolean | Returns v == null || isNaN(v). |
| static Number | Calculates a mod b, but the result is not allowed to be negative. |
| static Number | Rounds v to the nearest value that can be divided by intUnit. |
| static String | strDecodeBase64(s : String) Returns the result of decoding s from its base-64 equivalent. |
| static boolean | Returns whether s is null or an empty string. |
| static String | strEncodeBase64(s : String) Returns the result of encoding s to its base-64 equivalent. |
| static boolean | Returns whether s ends with strTest. |
| static String | strEscapeHTML(s : String) Returns s with the following four characters replaced by their escaped equivalent:
& < > ". |
| static String | strEscapeJSON(str : String) Returns str appropriately formatted and escaped for use as a JSON string. |
| static String | Returns s trimmed of trailing and leading spaces (anything matching the regexp /\s/). |
| static String | Limits s to length intMax by placing an ellipsis in values that are too long. |
| Method Detail |
|---|
o in a. Comparisons are performed with strict equals (===).v == null || isNaN(v).a mod b, but the result is not allowed to be negative.a mod b if a >= 0, b + a mod b, if a < 0. v to the nearest value that can be divided by intUnit.s from its base-64 equivalent.s is null or an empty string.s to its base-64 equivalent.s ends with strTest.s with the following four characters replaced by their escaped equivalent:
& < > ". This method also replaces any character that is not a valid XML character
(valid character codes are: 0x09, 0x0A, 0x0D, 0x20-0xD7FF, 0xE000-0xFFFD, 0x10000-0x10FFFF) with "\uXX" where XX
is the unicode hex value of the character.str appropriately formatted and escaped for use as a JSON string. If evaluated via
window.eval, the return from this method will be an exact match of the input.s trimmed of trailing and leading spaces (anything matching the regexp /\s/).s to length intMax by placing an ellipsis in values that are too long."..." is used by default.'' formats/parses a single quotation mark.GMT-08:00
-0800
| Field Summary | |
|---|---|
| static int | Type for a full-length localized date or time format. |
| static int | Type for a long localized date or time format. |
| static int | Type for a medium-length localized date or time format. |
| static int | Type for a short localized date or time format. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Formats a date according to this date format. |
| static jsx3.util.DateFormat | Returns a date format localized for a particular locale. |
| static jsx3.util.DateFormat | Returns a date and time format localized for a particular locale. |
| String | Returns the format passed to the constructor. |
| jsx3.util.Locale | |
| static jsx3.util.DateFormat | Returns a time format localized for a particular locale. |
| int | getTimeZoneOffset(objDate : Date) Returns the timezone offset of this date format. |
| Date | Parses a string according to this date format and returns the resulting date. |
| void | setLocale(objLocale : jsx3.util.Locale) |
| void | setTimeZoneOffset(intMinutes : int) Sets the timezone offset of this date format. |
| String | toString() Returns a string representation of this date format. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
strFormat cannot be parsed.| Method Detail |
|---|
SHORT, MEDIUM, LONG, or FULLSHORT, MEDIUM, LONG, or FULLSHORT, MEDIUM, LONG, or FULLSHORT, MEDIUM, LONG, or FULLsetTimeZoneOffset(), that value is returned.
Since the timezone offset may change over the year for Daylight Savings Time, this method takes a
Date argument, objDate. All dates are created with the timezone offset of the host
browser's timezone, adjusted for Daylight Savings Time. Therefore, if the timezone offset of this date format
has not been set explicitly, the timezone offset is determined from the objDate parameter, or, if
that is not provided, from the current time.strDate does
not conform to this date format, an exception is thrown.
The default date for the purposes of this method is 1-Jan-1970 12:00AM, local time. If any date fields
are omitted from this format, the date returned by this method will inherit those fields from the default date.strDate cannot be parsed according to this format.
| Field Summary | |
|---|---|
| static jsx3.util.EventDispatcher | A bridge to Dojo's publish/subscribe hub. |
| Method Summary | |
|---|---|
| static void | Returns the resolved path to Dojo or a file within Dojo. |
| static boolean | isLoaded() Returns whether Dojo has been loaded. |
| static void | load() Loads the Dojo JavaScript library. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
Dojo.load() must be called before this object can be used.| Method Detail |
|---|
dojo-toolkit/ as a peer of JSX/. This location may be overridden by setting the
jsx_dojo deployment parameter.jsx:/../dojo-toolkit or the
jsx_dojo deployment parameter must be set to the location where Dojo is installed.
| Field Summary | |
|---|---|
| static void | |
| Method Summary | |
|---|---|
| int | Publishes an event to all subscribed objects. |
| void | subscribe(strEventId : String | Array<String>, objHandler : Object | String | function, objFunction : function | String) Subscribes an object or function to a type of event published by this object. |
| void | Unsubscribe an object or function from an event published by this object. |
| void | unsubscribeAll(strEventId : String) Unsubscribes all subscribed objects to a type of event published by this object. |
| Field Detail |
|---|
| Method Detail |
|---|
subject property
objHandler is deprecated.objHandler is deprecated.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| boolean | add(objNode : ?) Adds objNode as a child of this node. |
| boolean | del(objNode : ?) Removes objNode as a child of this node. |
| Array<GNode> | down() Returns the child nodes of this node. |
| Graph | graph() Returns the graph that this node belongs to, if any. |
| String | Number | id() This function returns the unique ID of this node. |
| Array<GNode> | up() Returns the parent nodes of this node. |
| Methods Inherited From Object |
|---|
| toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
objNode as a child of this node. The node can only be added if both nodes already belong to
the same graph or neither node belongs to a graph.objNode as a child of this node.| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| boolean | add(objNode : GNode) Adds a sub-graph to this graph. |
| boolean | del(objNode : GNode) Removes a single node from this graph. |
| GNode | Returns a node by its ID. |
| Array<GNode> | nodes() Returns all the nodes of this graph. |
| Array<GNode> | roots() Returns all the root nodes of this graph. |
| int | size() Returns the number of nodes in this graph. |
| Methods Inherited From Object |
|---|
| toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
objNode is the root of the directed sub-graph.| Method Summary | |
|---|---|
| abstract boolean | hasNext() Returns whether there are more elements remaining in this iterator. |
| abstract Object | next() Returns the next element in this iterator. |
| abstract void | remove() Removes the last object returned by next() from the source backing this iterator. |
| Method Detail |
|---|
| Field Summary | |
|---|---|
| static int | Value that the run() method may return to indicate that the job has finished and any dependent
jobs should be run immediately. |
| static String | Event subject published when this job finishes. |
| static int | Value for the state property indicating that this job has finished. |
| static int | Value that the run() method may return to indicate that the job should be put back on the
waiting job queue. |
| static int | Value that the run() method may return to indicate that the job has finished and any dependent
jobs should be run after breaking the JavaScript stack with window.setTimeout(). |
| static int | Value that the run() method may return to indicate that the job will not finish until the
finish() method is called. |
| static int | Value for the state property indicating that this job has not yet finished. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | finish() A job should call this method on itself if its run() method returns WAIT to communicate to the
job manager that it has finished. |
| int | run() Runs the job. |
| void | state() Returns the job state. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.util.GNode |
|---|
| add, del, down, graph, id, up |
| Methods Inherited From Object |
|---|
| toString |
| Field Detail |
|---|
run() method may return to indicate that the job has finished and any dependent
jobs should be run immediately.run() method may return to indicate that the job should be put back on the
waiting job queue.run() method may return to indicate that the job has finished and any dependent
jobs should be run after breaking the JavaScript stack with window.setTimeout().run() method may return to indicate that the job will not finish until the
finish() method is called.| Constructor Detail |
|---|
| Method Detail |
|---|
WAIT to communicate to the
job manager that it has finished.WAIT, DONE, or SLEEP. | Field Summary | |
|---|---|
| static String | Event subject published when the job graph empties. |
| static String | Event subject published when a job is finished. |
| Constructor Summary | |
|---|---|
| void | init() The instance initializer. |
| Method Summary | |
|---|---|
| void | Add a job to this manager. |
| void | Adds a prerequisite to the job with id jobId. |
| void | doneCt() Returns the number of jobs that have finished. |
| void | Inserts newJob as a graph root and adds all children of referenceJob as children of
newJob. |
| boolean | |
| void | pause() Pauses this job manager. |
| void | reset() Resets this job manager. |
| void | start() Starts this job manager. |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From Object |
|---|
| toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
objJob is currently waiting in this manager or
if any prerequisite id does not correspond to a job not currently waiting in this job manager.
jobId.objJob.newJob as a graph root and adds all children of referenceJob as children of
newJob. This method is typically called in the "onDone" of referenceJob, when it
creates newJob and wants newJob to run before any dependent jobs of itself
(referenceJob).
Array class.
Note that methods such as indexOf and remove compare objects
with the strict equality operators (=== and !==). Therefore, for the purposes of this
class 1 and "1" are not equal.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | |
| void | |
| void | clear() Removes all elements from this list. |
| jsx3.util.List | clone() Returns a copy of this list. |
| boolean | |
| boolean | Returns true if this list and l have the same length and this.get(n) = l.get(n)
for all n. |
| jsx3.util.List | Creates a new list with the filtered contents of this list. |
| Object | |
| void | getIndex() Deprecated. Use the jsx3.util.Iterator interface instead.
|
| void | getItem(intIndex : ?) Deprecated. Use get() instead.
|
| void | Deprecated. Use size() instead.
|
| void | hasNext() Deprecated. Use the jsx3.util.Iterator interface instead.
|
| int | Returns the index of the first occurrence of objElm in this list. |
| jsx3.util.Iterator | iterator() |
| int | Returns the index of the last occurrence of objElm in this list. |
| jsx3.util.List | Object | Creates a new list with the mapped contents of this array. |
| void | move(intIndex : ?) Deprecated. Use the jsx3.util.Iterator interface instead.
|
| void | next() Deprecated. Use the jsx3.util.Iterator interface instead.
|
| void | Removes the first occurrence of objElm in this list. |
| Object | jsx3.util.List<Object> | Removes a single or a range of elements from this list. |
| void | reset() Deprecated. Use the jsx3.util.Iterator interface instead.
|
| void | |
| int | size() |
| List | Returns a section of this list as another list. |
| void | Sorts this list. |
| Array | Returns a copy of this list as an array. |
| static jsx3.util.List | wrap(a : Array | jsx3.util.List) If a is already an instance of this class, this method returns a. |
| Methods Inherited From jsx3.lang.Object |
|---|
| eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
a is a number, the list is initialized with
that size. If a is an array or list, the contents of a are copied into the new list.| Method Detail |
|---|
l have the same length and this.get(n) = l.get(n)
for all n.fctFilter parameter defines
the filtering function.function(item : Object) : boolean.jsx3.util.Iterator interface instead.
get() instead.
size() instead.
jsx3.util.Iterator interface instead.
objElm in this list. Comparisons are performed with
strict equals (===).-1 if not found.
objElm in this list. Comparisons are performed with
strict equals (===).fctMapper parameter defines
the mapping function.
This method has four modes corresponding to the four possible values for {bExpand, bObject}:
{false, false} (default) – the filtering function takes an item in this list and returns
a single object value which will take the place of the item in the mapped result.{true, false} – the filtering function takes an item in this list and returns
a single object value or an array of values, all of which will be inserted into the mapped result at the index
of the item.{false, true} – the filtering function takes an item in this list and returns an array with
exactly two values, which become a name/value pair in the mapped result.{true, true} – the filtering function takes an item in this list and returns an array with
zero or an even number of items, which become name/value pairs in the mapped result.bExpand and
bObject parameters.true, the resulting mapped array or object may any number of values
corresponding to each item in this list. Otherwise, it will have exactly one value for each item in this list.true, this array is mapped to an object with property name/value pairs.
Otherwise this array is mapped to another array.bObject parameter is null or
false, otherwise an Object.
jsx3.util.Iterator interface instead.
jsx3.util.Iterator interface instead.
objElm in this list.jsx3.util.Iterator interface instead.
a is already an instance of this class, this method returns a.
If a is an array, this method returns a new List instance backed by a.a is not a list or array.
| Field Summary | |
|---|---|
| static jsx3.util.Locale | Locale for English (country unspecified). |
| static jsx3.util.Locale | Locale for United Kingdom. |
| static jsx3.util.Locale | Locale for United States of America. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| boolean | Returns true if obj is equal to this locale. |
| String | Returns the uppercase two letter ISO-3166 country code. |
| String | getDisplayCountry(objLocale : jsx3.util.Locale) Returns the country of this locale, localized for objLocale. |
| String | getDisplayLanguage(objLocale : jsx3.util.Locale) Returns the language of this locale, localized for objLocale. |
| String | getDisplayName(objLocale : jsx3.util.Locale) Returns the language and country of this locale, localized for objLocale. |
| String | Returns the lowercase two letter ISO-639 language code. |
| String | toString() |
| static jsx3.util.Locale | Returns a locale instance represented by strKey. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
obj is equal to this locale.objLocale.objLocale.objLocale.strKey.ll_CC, where ll is the two letter language
code and CC is the two letter country code.global is the parent of com is the parent
of com.tibco is the parent of com.tibco.gi, etc.
A Logger has a level that determines what severity of messages will be handled. Messages with severity below the
level of the Logger will be ignored. If the level of a Logger is not explicitly defined, the level is inherited
from its parent.
A Logger can have any number of handlers, each of which can output a log message to a different place. By default
a logger will also forward log messages to the handlers of its ancestors, although this can be disabled per Logger.
A typical usage pattern is to create a Logger for each class, setting it as a private static field of that class,
as in the following code example:
jsx3.Class.defineClass('eg.Thing', null, null, function(Thing, Thing_prototype) {
// import jsx3.util.Logger
var Logger = jsx3.util.Logger;
// create Logger for this class
Thing._LOG = Logger.getLogger(Thing.jsxclass.getName());
Thing.prototype.init = function(arg1, arg2, arg2) {
Thing._LOG.debug("received args: " + arg1 + ", " + arg2 + ", " + arg3);
if (isNaN(arg1)) {
Thing._LOG.warn("arg1 is not a number, setting to 0");
this._one = 0;
} else {
this._one = arg1;
}
};
});
If the creation of the log message is expensive (depending on the implementation,
toString() can be expensive), isLoggable() can be used to check whether the log
statement will actually be handled before creating the log message:
if (LOG.isLoggable(jsx3.util.Logger.INFO)) LOG.info(anObject.toString());
| Nested Class Summary | |
|---|---|
| jsx3.util.Logger.AlertHandler | Handles a logging record by sending it to a JavaScript alert. |
| jsx3.util.Logger.ConsoleHandler | Handles a logging record by sending it to the Firebug console. |
| jsx3.util.Logger.FormatHandler | A subclass of Handler that includes functionality for formatting logging records as human-readable
strings. |
| jsx3.util.Logger.Handler | The base logging handler class. |
| jsx3.util.Logger.Manager | Manager class for the logging system. |
| jsx3.util.Logger.MemoryHandler | A simple Handler class that stores a rotating cache of log records in memory. |
| jsx3.util.Logger.Record | Record bean that stores information about a logging message. |
| Field Summary | |
|---|---|
| static int | Level indicating debug message. |
| static int | Level indicating error. |
| static int | Level indicating fatal error. |
| static jsx3.util.Logger | Convenient access to jsx3.util.Logger.getLogger('global'). |
| static int | Level indicating informational message. |
| static int | Set the level of a Logger or Handler to this value to ignore all messages. |
| static int | Level indicating trace message. |
| static int | Level indicating warning. |
| Method Summary | |
|---|---|
| void | addHandler(objHandler : jsx3.util.Logger.Handler) Add a handler to this Logger. |
| void | Log a message at level DEBUG. |
| static void | Deprecated. use either jsx3.log or Logger.log() |
| void | Log a message at level ERROR. |
| static String | errorToString(error : ?) Deprecated. |
| void | Log a message at level FATAL. |
| int | Returns the effective level of this Logger, which is either the explicitly set value of this Logger or the
effective level of this Logger's parent Logger. |
| int | getLevel() Returns the level of this Logger. |
| static Object | getLog() Deprecated. returns an empty array
|
| static jsx3.util.Logger | Returns an Logger instance. |
| static void | Deprecated. use Logger.isLoggable()
|
| String | getName() Returns the name of this Logger. |
| jsx3.util.Logger | Returns the parent Logger of this Logger. |
| boolean | Returns whether this Logger will publish log messages to the handlers of its parent Logger. |
| void | Log a message at level INFO. |
| boolean | isLoggable(intLevel : int) Returns true if a log message sent to this logger at level intLevel will be forwarded on to the
handlers of this logger. |
| static String | levelAsString(intLevel : int) Returns the string (English) representation of a level value. |
| void | Log a message. |
| void | Log an exception. |
| static void | Deprecated. use instance method Logger.logError()
|
| void | Log the current stack with a message. |
| void | removeHandler(objHandler : jsx3.util.Logger.Handler) Remove a handler from this Logger. |
| static void | reset() Deprecated. no effect
|
| void | Sets the level of this Logger. |
| void | setParent(objParent : jsx3.util.Logger) Sets the parent Logger of this Logger. |
| void | setUseParentHandlers(bUseParent : boolean) Sets whether this Logger will publish log messages to the handlers of its parent Logger. |
| static Object | toString() Deprecated. Returns empty string.
|
| void | Log a message at level TRACE. |
| void | Log a message at level WARN. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Field Detail |
|---|
jsx3.util.Logger.getLogger('global').
| Method Detail |
|---|
log() or
logError() (without the first intLevel parameter).jsx3.log or Logger.log()PRIORITY
argument to a valid value for Logger, defaults to INFO.log() or
logError() (without the first intLevel parameter).log() or
logError() (without the first intLevel parameter).Logger.isLoggable()
log() or
logError() (without the first intLevel parameter).intLevel will be forwarded on to the
handlers of this logger.Logger.logError()
log() or
logError() (without the first intLevel parameter).log() or
logError() (without the first intLevel parameter).| Method Summary | |
|---|---|
| int | Returns the message interval at which the user has the opportunity to disable this handler. |
| void | setConfirmInterval(intInterval : int) Sets the message interval at which the user has the opportunity to disable this handler. |
| Methods Inherited From jsx3.util.Logger.FormatHandler |
|---|
| getFormat, setFormat |
| Methods Inherited From jsx3.util.Logger.Handler |
|---|
| getLevel, getName, handle, isLoggable, setLevel |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
| Methods Inherited From jsx3.util.Logger.FormatHandler |
|---|
| getFormat, setFormat |
| Methods Inherited From jsx3.util.Logger.Handler |
|---|
| getLevel, getName, handle, isLoggable, setLevel |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
Handler that includes functionality for formatting logging records as human-readable
strings.
The following tokens are supported in the format:
| Method Summary | |
|---|---|
| String | Returns the format to use for formatting logging records. |
| void | Sets the format to use for formatting logging records. |
| Methods Inherited From jsx3.util.Logger.Handler |
|---|
| getLevel, getName, handle, isLoggable, setLevel |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
handle() method. This method defines what
to do to "handle" the logging record. This method does not need to check the handler's level against the level
of the record. The the logger does this before calling handle() and will not call
handle() if the record's level is not severe enough.
| Constructor Summary | |
|---|---|
| void | |
| Method Summary | |
|---|---|
| int | getLevel() Returns the level of this handler. |
| String | getName() Returns the name of this Handler. |
| abstract void | handle(objRecord : jsx3.util.Logger.Record) Concrete subclasses of this class must implement this method, which defines how a log record is handled. |
| boolean | isLoggable(intLevel : int) Returns true if a log message sent to this handler at level intLevel will be processed rather than
ignored. |
| static void | registerHandlerClass(objClass : jsx3.lang.Class) Call this method to let the logging system know that a new subclass of Handler has been defined. |
| int | setLevel(intLevel : ?) Sets the level of this handler. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
null if no level has been specified.intLevel will be processed rather than
ignored.jsx_logger_config,
or if that is not provided, by the default configuration file located at $GI/logger.xml.
The DTD of that configuration file is as follows:
<!ELEMENT configuration (handler | logger)* >
<!ELEMENT handler (property)* >
<!ATTLIST handler name CDATA #REQUIRED
class CDATA #REQUIRED
lazy (true|false) "false"
require (true|false) "false"
level (OFF|FATAL|ERROR|WARN|INFO|DEBUG|TRACE) #IMPLIED>
<!ELEMENT logger (property | handler-ref)* >
<!ATTLIST logger name CDATA #REQUIRED
useParent (true|false) "true"
level (OFF|FATAL|ERROR|WARN|INFO|DEBUG|TRACE) #IMPLIED>
<!-- Properties allow for bean-style configuration of handlers and loggers.
The class should have a setter method corresponding to the name of the
property. -->
<!ELEMENT property (EMPTY)>
<!ATTLIST property name CDATA #REQUIRED
value CDATA #REQUIRED
eval (true|false) "false">
<!ELEMENT handler-ref (EMPTY)>
<!ATTLIST handler-ref name CDATA #REQUIRED>
| Method Summary | |
|---|---|
| void | addHandler(objHandler : jsx3.util.Logger.Handler) Add a Handler instance to this manager's registry. |
| void | addLogger(objLogger : jsx3.util.Logger) Add a Logger instance to the manager's registry. |
| jsx3.util.Logger.Handler | getHandler(strName : ?) Returns a Handler from the manager's registry by name, or null if no such Handler is registered. |
| Array<String> | Returns a list containing the names of all the handlers registered with this manager. |
| jsx3.util.Logger | getLogger(strName : ?) Returns a Logger from this manager's registry by name, or null if no such Logger is registered. |
| static jsx3.util.Logger.Manager | Singleton accessor method. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Method Detail |
|---|
bufferSize property (default 100).
| Constructor Summary | |
|---|---|
| void | init(strName : ?) Instance initializer. |
| Method Summary | |
|---|---|
| void | Clears the contents of the buffer. |
| int | Returns the size of the buffer. |
| Array<jsx3.util.Logger.Record> | getRecords(intCount : int) Returns the contents of the record buffer. |
| void | handle(objRecord : jsx3.util.Logger.Record) Stores the log record in memory. |
| void | setBufferSize(intBufferSize : int) Sets the size of the buffer. |
| Methods Inherited From jsx3.util.Logger.Handler |
|---|
| getLevel, getName, isLoggable, setLevel |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
null to get all records.| Constructor Summary | |
|---|---|
| void | init(strMessage : String, arrParams : Array<Object>, intLevel : int, strLogger : String, arrStack : Function | Array<Function>, objError : jsx3.lang.Exception) Instance initializer. |
| Method Summary | |
|---|---|
| Date | getDate() Returns the current date when this record was created. |
| jsx3.lang.Exception | getError() Returns the exception that this record was created with. |
| Function | Returns the JavaScript function that called the Logger message that created this record. |
| int | getLevel() Returns the logging level that this record was created with. |
| String | Returns the name of the logger that created this record. |
| String | Returns the raw message of this record. |
| Array<Object> | Returns the message parameters of this record. |
| int | Returns this record's serial number. |
| Array<Function> | getStack() Returns the complete JavaScript stack from when this record was created. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
Logger.logError() or similar.n is the
zero-based parameter index:
param,
depends on its data type:
null — "null"string — paramnumber — {n,number}Object — param.toString()Date — {n,datetime,short}new MessageFormat("A curly bracket: '{'"). To insert a single quote character, use two single
quotes in succession: new MessageFormat("A single quote: ''").| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | Formats a collection of objects according to this message format. |
| jsx3.util.Locale | Returns the locale of this message format. |
| void | setLocale(objLocale : jsx3.util.Locale) Sets the locale of this message format. |
| String | toString() |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
strFormat cannot be parsed.
| Method Detail |
|---|
Prefix Format Suffix. A single number format can specify a format for
a positive value and one for a negative value. In this case the form is: PosPrefix PosFormat
PosSuffix;NegPrefix NegFormat NegSuffix. (The spaces between prefix, format, and suffix should not be
included in the actual format.)
The format can include the following characters. Each character is replaced with the locale-specific text when
a number is formatted.
0 - Digit# - Digit, zero shows as absent. - Decimal separator or monetary decimal separator- - Minus sign, - Grouping separator; - Separates positive and negative subpatterns% - Multiply by 100 and show as percentage‰ - Multiply by 1000 and show as per-mille¤ - Currency sign, replaced by currency symbol' - Used to quote special characters in a prefix or suffix. To create a single quote
itself, use two in a row| Field Summary | |
|---|---|
| static int | Type for a currency number format. |
| static int | Type for an integer number format. |
| static int | Type for a decimal number format. |
| Constructor Summary | |
|---|---|
| void | Creates a new number format instance. |
| Method Summary | |
|---|---|
| String | |
| static jsx3.util.NumberFormat | getCurrencyInstance(objLocale : jsx3.util.Locale) Returns a currency number format appropriate for objLocale. |
| static jsx3.util.NumberFormat | Returns a number format appropriate for objLocale. |
| static jsx3.util.NumberFormat | getIntegerInstance(objLocale : jsx3.util.Locale) Returns an integer number format appropriate for objLocale. |
| jsx3.util.Locale | |
| static jsx3.util.NumberFormat | getNumberInstance(objLocale : jsx3.util.Locale) Returns a general number format appropriate for objLocale. |
| static jsx3.util.NumberFormat | getPercentInstance(objLocale : jsx3.util.Locale) Returns a percent number format appropriate for objLocale. |
| Number | Parses a string according to this number format and returns the resulting value. |
| void | setLocale(objLocale : jsx3.util.Locale) |
| String | toString() |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
strFormat cannot be parsed.
| Method Detail |
|---|
objLocale.objLocale.NUMBER, INTEGER, or CURRENCY.objLocale.objLocale.objLocale.| Class Summary | |
|---|---|
| jsx3.vector.Block | Defines a base class for GUI controls that implement both the cross-platform box profile painting introduced in
3.2 and the cross-platform (VML/SVG) vector painting, also introduced in 3.2. |
| jsx3.vector.Canvas | Represents a vector canvas in which vector shapes are painted. |
| jsx3.vector.Fill | Represents a vector fill, the color and gradient that fills a solid vector shape. |
| jsx3.vector.Group | Represents a grouping of vector shapes. |
| jsx3.vector.Line | Paints a vector line defined by two end points. |
| jsx3.vector.LineGroup | A more efficient way of painting many vector lines of the same color and thickness. |
| jsx3.vector.Oval | Paints a vector oval bounded by the box defined by its left, top, width, and height. |
| jsx3.vector.Polygon | Paints a vector polygon defined by a set of points. |
| jsx3.vector.Rectangle | Paints a vector rectangle. |
| jsx3.vector.RectangleGroup | A more efficient way of painting many vector rectangles of the same fill and stroke. |
| jsx3.vector.Shape | Represents a vector shape element. |
| jsx3.vector.Stroke | Represents a vector line style. |
| jsx3.vector.Tag | The base class for jsx3.vector.Group and jsx3.vector.Shape. |
| jsx3.vector.TextLine | Renders text along an arbitrary line. |
| Method Summary | |
|---|---|
| static String | colorAsHtml(color : int | String) Converts an integer color to a CSS hex string color. |
| static Number | degreesToRadians(degrees : Number) Converts degrees (0 at North, clockwise) to radians (0 at East, counterclockwise). |
| static void | paintEventHandler(obj : jsx3.app.Model, strEvtType : String, strMethod : String, objElm : jsx3.vector.Tag) Renders a cross-platform vector event handler. |
| static void | Updates a rendered vector HTML element, objExisting, with an in-memory vector tag,
objNew. |
| Method Detail |
|---|
jsx3.gui.Event.CLICK, etc.obj when the event is received.objExisting, with an in-memory vector tag,
objNew. For example,
var objElm = document.getElementById("vectorId");
var objVector = new jsx3.vector.Oval(0, 0, 100, 100);
objVector.setFill(new jsx3.vector.Fill(0xFFFF00));
jsx3.vector.updateVector(objVector, objElm);
| Method Summary | |
|---|---|
| jsx3.vector.Tag | Instantiates and returns a new instance of jsx3.vector.Canvas. |
| jsx3.vector.Tag | Creates the vector tag tree that will render this GUI control. |
| jsx3.vector.Tag | Returns the vector canvas on which this control paints itself. |
| void | Renders a cross-platform vector event handler. |
| boolean | updateVector(objVector : jsx3.vector.Tag) Updates the pre-existing vector tree of this control on, for example, a resize or repaint event. |
| Methods Inherited From jsx3.gui.Interactive |
|---|
| doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy |
| Methods Inherited From jsx3.gui.Painted |
|---|
| focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Method Detail |
|---|
jsx3.vector.Canvas. The implementation of
createVector() in this class calls this method to create the base vector tag. This method may be
overridden to provide a base tag of another type that Canvas.
CustomVector.prototype.createVector = function() {
var objCanvas = this.jsxsuper();
// modify objCanvas, add children, etc.
return objCanvas;
};
This method should do the work of creating and updating the vector tree to the state when it is ready to be
rendered on screen, but without calling updateVector() directly.createVector() is called to create it.strEvtType bubbles up to the
HTML element rendered by objElm, the instance method of this object whose name is
strMethod will be called with two parameters: the browser event wrapped in an instance of
jsx3.gui.Event, and the native HTMLElement that defined the event handler.jsx3.gui.Event.CLICK, etc.true if the update is successful or false to
force the vector tree to be completely recreated with createVector().
The basic template for a method overriding this method is:
CustomVector.prototype.updateVector = function(objVector) {
this.jsxsuper(objVector);
// modify objCanvas, modify children, etc.
return true;
};
true if the tree could be updated inline or false if it must be
recreated by calling createVector(). | Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| float | getAlpha() Returns the alpha field, as previously set in the constructor or with setAlpha(). |
| float | Returns the alpha2 field, as set with setAlpha2(). |
| int | getAngle() Returns the angle field (the angle along which the gradient goes), as set with setAngle(). |
| void | getColor() Returns the color field, as previously set in the constructor or with setColor(). |
| void | Returns the color2 field, as set with setColor2(). |
| void | ? getColor2Html() {String} gets the color2 field, as a CSS hex string
|
| String | Returns the color field, as a CSS hex string. |
| String | Returns the colors field, as set with setColors(). |
| String | getType() Returns the type field, as set with setType(). |
| void | Sets the alpha field, valid values are between 0 (transparent) and 1 (opaque). |
| void | Sets the alpha2 field, valid values are between 0 (transparent) and 1 (opaque). |
| void | Sets the angle field, valid values are between 0 and 360. |
| void | Sets the color field. |
| void | Sets the color2 field. |
| void | Sets the colors field, see the documentation for |
| void | Sets the type field, valid values are enumerated in the VML specification, though only 'solid', 'gradient', and 'gradientradial' are truly supported by this class. |
| static jsx3.vector.Fill | valueOf(v : String | jsx3.vector.Fill) Parses a vector fill from its string representation. |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
"color alpha".null if v is empty, v if v
is already a vector fill, or otherwise a new vector fill created by parsing the string according to the
format specified above.
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Methods Inherited From jsx3.vector.Tag |
|---|
| getRotation, getToolTip, setRotation, setToolTip |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| int | getX1() Returns the x1 field. |
| int | getX2() Returns the x2 field. |
| int | getY1() Returns the y1 field. |
| int | getY2() Returns the y2 field. |
| void | Sets all the coordinates at once. |
| void | Sets the x1 field. |
| void | Sets the x2 field. |
| void | Sets the y1 field. |
| void | Sets the y2 field. |
| Methods Inherited From jsx3.vector.Shape |
|---|
| getFill, getPath, getStroke, pathArcTo, pathClose, pathLineTo, pathMoveTo, setFill, setPath, setStroke |
| Methods Inherited From jsx3.vector.Tag |
|---|
| getRotation, getToolTip, setRotation, setToolTip |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | add a line to the group |
| void | add a line to the group |
| void | clear all lines out of the group
|
| Methods Inherited From jsx3.vector.Shape |
|---|
| getFill, getPath, getStroke, pathArcTo, pathClose, pathLineTo, pathMoveTo, setFill, setPath, setStroke |
| Methods Inherited From jsx3.vector.Tag |
|---|
| getRotation, getToolTip, setRotation, setToolTip |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Methods Inherited From jsx3.vector.Shape |
|---|
| getFill, getPath, getStroke, pathArcTo, pathClose, pathLineTo, pathMoveTo, setFill, setPath, setStroke |
| Methods Inherited From jsx3.vector.Tag |
|---|
| getRotation, getToolTip, setRotation, setToolTip |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | Sets the polygon points as an array of point objects or strings. |
| void | setPointsAsNumberArray(points : Array) Sets the polygon points as an array of coordinates. |
| void | setPointsAsString(points : String) Sets the points as a string. |
| Methods Inherited From jsx3.vector.Shape |
|---|
| getFill, getPath, getStroke, pathArcTo, pathClose, pathLineTo, pathMoveTo, setFill, setPath, setStroke |
| Methods Inherited From jsx3.vector.Tag |
|---|
| getRotation, getToolTip, setRotation, setToolTip |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | Clips this rectangle to the bounds of {l1, t1, w1, h1}. |
| void | clipToBox(obj : jsx3.gui.Block | jsx3.html.BlockTag) Clips this rectangle to the bounds of obj. |
| Methods Inherited From jsx3.vector.Shape |
|---|
| getFill, getPath, getStroke, pathArcTo, pathClose, pathLineTo, pathMoveTo, setFill, setPath, setStroke |
| Methods Inherited From jsx3.vector.Tag |
|---|
| getRotation, getToolTip, setRotation, setToolTip |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
obj.getLeft(), etc methods.
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | add a rectangle to this group |
| void | add a rectangle to this group |
| void | clear all rectangles out of the group
|
| Methods Inherited From jsx3.vector.Shape |
|---|
| getFill, getPath, getStroke, pathArcTo, pathClose, pathLineTo, pathMoveTo, setFill, setPath, setStroke |
| Methods Inherited From jsx3.vector.Tag |
|---|
| getRotation, getToolTip, setRotation, setToolTip |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| void | getFill() Returns the fill of this shape. |
| String | getPath() Returns the path field. |
| void | Returns the stroke of this shape. |
| jsx3.vector.Shape | |
| jsx3.vector.Shape | |
| jsx3.vector.Shape | |
| jsx3.vector.Shape | |
| void | setFill(fill : jsx3.vector.Fill) Sets the fill of this shape, other fills may be present as children of this instance. |
| void | Sets the path field. |
| void | setStroke(stroke : jsx3.vector.Stroke) Sets the stroke of this shape, other strokes may be present as children of this instance. |
| Methods Inherited From jsx3.vector.Tag |
|---|
| getRotation, getToolTip, setRotation, setToolTip |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| float | getAlpha() Returns the alpha field. |
| int | String | getColor() Returns the color field. |
| String | Returns the color field, as a CSS hex string. |
| int | getWidth() Returns the width field. |
| void | Sets the alpha field. |
| void | Sets the color field. |
| void | Sets the width field. |
| static VectorStroke | parses a VectorStroke from a string representation, that format is "color width alpha" |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| int | Returns the rotation field. |
| void | Returns the tooltip, the text that is displayed on mouse over. |
| void | setRotation(rotation : int) Sets the rotation field, an angle between 0 and 360. |
| void | setToolTip(title : String) Sets the tooltip, the text that is displayed on mouse over. |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| String | getText() Returns the text field. |
| void | Sets the text field, the text to display on the text path. |
| Methods Inherited From jsx3.html.FontTag |
|---|
| getColor, getFontFamily, getFontSize, getFontStyle, getFontWeight, getTextAlign, getTextDecoration, setColor, setFontFamily, setFontSize, setFontStyle, setFontWeight, setTextAlign, setTextDecoration |
| Methods Inherited From jsx3.vector.Shape |
|---|
| getFill, getPath, getStroke, pathArcTo, pathClose, pathLineTo, pathMoveTo, setFill, setPath, setStroke |
| Methods Inherited From jsx3.vector.Tag |
|---|
| getRotation, getToolTip, setRotation, setToolTip |
| Methods Inherited From jsx3.html.BlockTag |
|---|
| getBackgroundColor, getDimensions, getHeight, getLeft, getMargin, getMarginDimensions, getPadding, getPaddingDimensions, getPosition, getTop, getWidth, getZIndex, setBackgroundColor, setDimensions, setHeight, setLeft, setMargin, setPadding, setPosition, setTop, setWidth, setZIndex |
| Methods Inherited From jsx3.html.Tag |
|---|
| appendChild, getChildren, getClassName, getFirstChildOfType, getId, getParent, getProperty, getStyle, getTagNS, getTagName, onAppendChild, onRemoveChild, paint, paintDom, paintUpdate, release, removeChild, removeChildren, removeProperty, removeStyle, replaceChild, setClassName, setExtraStyles, setId, setProperty, setStyle, toString |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Class Summary | |
|---|---|
| jsx3.xml.CDF | Mixin interface that provides methods for accessing and manipulating an XML document in CDF schema. |
| jsx3.xml.CDF.Document | A subclass of jsx3.xml.Document that implements the CDF interface. |
| jsx3.xml.Cacheable | A mixin interface that provides the following capabilities to implementing classes:
|
| jsx3.xml.Document | Wrapper of the native browser XML document class. |
| jsx3.xml.DojoDataStore | Provides access to Dojo data store through the CDF interface. |
| jsx3.xml.Entity | Wrapper of the native browser XML node class. |
| jsx3.xml.Processor | Deprecated. Use jsx3.xml.Template instead. |
| jsx3.xml.Template | Wrapper of the native browser XSLT processor. |
| jsx3.xml.XslDocument | An extension of jsx3.xml.Document that encapsulates a compiled XSL template. |
getXML() method. This interface uses
that method to access the XML document for which it provides a CDF interface.
| Class Summary | |
|---|---|
| jsx3.xml.CDF.Document | A subclass of jsx3.xml.Document that implements the CDF interface. |
| Field Summary | |
|---|---|
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static String | |
| static int | |
| static String | |
| static String | |
| static int | |
| static int | |
| static int | |
| Method Summary | |
|---|---|
| jsx3.xml.Entity | adoptRecord(strSourceId : String | jsx3.xml.CDF, strRecordId : String, strParentRecordId : String, bRedraw : boolean) Transfers a CDF record from another object to this object. |
| jsx3.xml.Entity | adoptRecordBefore(strSourceId : String | jsx3.xml.CDF, strRecordId : String, strSiblingRecordId : String, bRedraw : boolean) Equivalent to adoptRecord, except that the to-be relationship is as a previousSibling to the CDF record identified by the parameter, strSiblingRecordId
This method fails quietly if any of the following conditions apply:
there is no record with a jsxid equal to strSourceId
there is no record in the source object with a jsxid equal to strRecordId
strSiblingRecordId is specified and there is no record in this object with a
jsxid equal to strParentRecordId
this object already has a record with jsxid equal to the record to adopt
|
| void | Converts all attributes in this CDF document that are property keys of the form {key} to
the value of the property. |
| jsx3.xml.Entity | Removes a record from the XML data source of this object. |
| void | Removes a specific property from a record. |
| static String | getKey() Generates a unique jsxid attribute for a CDF record. |
| Object<String, String> | Returns an object containing the attributes of a particular CDF record as property/value pairs. |
| void | Returns an array of jsxid from this CDF . |
| jsx3.xml.Entity | getRecordNode(strRecordId : String) Returns a record from the XML data source of this object. |
| static String | Deprecated. |
| jsx3.xml.Entity | Inserts a new record into the XML data source of this object. |
| jsx3.xml.Entity | insertRecordBefore(objRecord : Object<String, String>, strSiblingRecordId : String, bRedraw : boolean) Creates a new CDF record and inserts it into the CDF data source of this object, before the record identified by strSiblingRecordId. |
| void | Inserts a new record into the XML data source of this object. |
| jsx3.xml.CDF | insertRecordProperty(strRecordId : String, strPropName : String, strPropValue : String, bRedraw : boolean) Inserts a new property into an existing record with jsxid equal to strRecordId. |
| static jsx3.xml.Document | Creates a new XML document that represents an empty CDF document. |
| abstract void | An abstract method that must be implemented by any class that implements this interface. |
| jsx3.xml.Document | reloadFromSource(bSystem : boolean) Deprecated. use jsx3.xml.Cacheable.resetXmlCacheData() instead |
| void | Deprecated. Use jsx3.xml.Cacheable.clearXmlData() instead. |
| Field Detail |
|---|
| Method Detail |
|---|
strSourceId
strRecordId
strParentRecordId is specified and there is no record in this object with
jsxid equal to strParentRecordId
jsxid attribute of the data record in the source object to transfer.jsxid of an existing record. If this optional parameter
is provided, the adopted record will be added as a child of this record. Otherwise, the adopted record will
be added to the root data element.strSourceId
strRecordId
strSiblingRecordId is specified and there is no record in this object with a
jsxid equal to strParentRecordId
jsxid attribute of the data record in the source object to transfer.jsxid of an existing record in front of
which the record identified by strSourceId will be placedtrue or null, the on-screen view of this object is
immediately updated to reflect the deleted record.{key} to
the value of the property.true, arrProps is combined with the default set of
attributes and those attributes are converted.
jsxid attribute of the data record to remove.true or null, the on-screen view of this object is
immediately updated to reflect the deleted record.null if no such record found.
jsxid attribute of the data record to modify.true or null, the on-screen view of this object is
immediately updated to reflect the deleted property.
jsxid attribute for a CDF record. This method can be used for new CDF records
when there is no natural unique key to assign to them.
objCDF.getRecord(strId).propName;
objCDF.getRecordNode(strId).getAttribute("propName");
jsxid attribute of the data record to return.null if no such record found. redrawRecord(strRecordId, jsx3.xml.CDF.UPDATE); on this object.jsxid attribute of the data record to return.null if none exists with a jsxid
attribute equal to strRecordId. jsxid property of objRecord,
the operation is treated as an update, meaning the existing record is completely removed and a new record with
the given jsxid is inserted.jsxid that is unique across all records in the XML document.
All property values will be treated as strings. Additionally, the following 3 characters are escaped:
" > <.jsxid of an existing record. If this optional parameter
is provided and a record exists with a matching jsxid attribute, the new record will be added as a child of
this record. Otherwise, the new record will be added to the root data element. However, if a
record already exists with a jsxid attribute equal to the jsxid property of
objRecord, this parameter will be ignored. In this case adoptRecord() must be called
to change the parent of the record.true or null, the on-screen view of this object is
immediately updated to reflect the additional record.strSiblingRecordId
objRecord.jsxid
jsxid that is unique across all records in the XML document.
All property values will be treated as strings. Additionally, the following 3 characters are escaped:
" > <.jsxid of an existing record before which the new record will be inserted.true or null, the on-screen view of this object is
immediately updated to reflect the additional record.insertRecord() except that its first parameter is of type jsx3.xml.Entity rather than
Object.record. Note that most classes that
implement this interface require that all records have an attribute named jsxid that is unique
across all records in the XML document.jsxid of an existing record. If this optional parameter
is provided and a record exists with a matching jsxid attribute, the new record will be added as a child of
this record. Otherwise, the new record will be added to the root data element.true or null, the on-screen view of this object is
immediately updated to reflect the additional record.jsxid equal to strRecordId.
If the property already exists, the existing property value will be updated. If no such record exists
in the XML document, this method fails quietly.jsxid attribute of the data record to modify.true or null, the on-screen view of this object is
immediately updated to reflect the inserted property.<data jsxid="jsxroot"/>.jsxid attribute of the data record to redraw.INSERT, UPDATE, or DELETE.jsx3.xml.Cacheable.resetXmlCacheData() insteadresetData() in that this method does not reset the XML
document of this object to an empty CDF document.jsx3.xml.Cacheable.clearXmlData() instead.CDF.newDocument() and places the document
in the server cache.true or null, the on-screen view of this object is
immediately updated to reflect the inserted property.jsx3.xml.Document that implements the CDF interface. This class simply exposes the CDF
convenience methods on an XML document.
| Method Summary | |
|---|---|
| jsx3.xml.Document | getXML() Returns this document to conform to the contract of the jsx3.xml.CDF interface. |
| static jsx3.xml.CDF.Document | Creates a new XML document that represents an empty CDF document. |
| void | No-op. |
| static jsx3.xml.CDF.Document | wrap(objXML : jsx3.xml.Document) |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource, resetData |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Method Detail |
|---|
jsx3.xml.CDF interface.<data jsxid="jsxroot"/>.jsxid attribute of the data record to redraw.INSERT, UPDATE, or DELETE.
jsx3.app.Model since this
interface assumes that its instances have methods in that class (in particular getId() and
getServer()).
As of version 3.2 using custom XSL templates for built-in GUI classes implementing this interface is deprecated.
Therefore, several methods related to storing per-instance XSL documents are deprecated.| Field Summary | |
|---|---|
| static int | Value of the shareResources property for an object that removes its XML and XSL
documents from the server XML cache when it is destroyed. |
| static String | JSX/xsl/xml.xsl
|
| static String | Deprecated. |
| static int | Value of the shareResources property for an object that leaves its XML and XSL
documents in the server XML cache when it is destroyed. |
| Method Summary | |
|---|---|
| void | Resets the XML source document stored in the server cache under the XML ID of this object to an empty CDF
document. |
| jsx3.xml.Entity | Deprecated. |
| int | Returns whether this object removes its XML and XSL source documents from the cache of its server when it
is destroyed. |
| static String | Deprecated. |
| jsx3.xml.Document | getXML() Returns the XML source document of this object. |
| String | getXMLId() Returns the XML ID of this object. |
| String | Returns the XML string of this object. |
| Array<String> | Returns the list of XML transformers of this object. |
| String | Returns the XML URL of this object. |
| jsx3.xml.Document | getXSL() Returns the XSL source document of this object. |
| String | getXSLId() Returns the XSL ID of this object. |
| Object<String, String> | Returns a map containing all the parameters to pass to the XSL stylesheet during transformation. |
| String | Deprecated. Per-instance control of the XSL template is deprecated. Consider using the XML transformers
functionality instead. |
| String | Deprecated. Per-instance control of the XSL template is deprecated. Consider using the XML transformers
functionality instead. |
| int | Returns whether the XML data source of this object is loaded asynchronously. |
| int | Returns whether this object is bound to the XML document stored in the data cache. |
| protected void | onXmlBinding(objEvent : Object) This method is called in two situations:
When the datasource of this object finishes loading (success, error, or timeout), if the
xmlAsync property of this object is true, its datasource is specified as an
XML URL, and the first time doTransform() was called the datasource was still loading. |
| jsx3.xml.Cacheable | removeXSLParam(strName : String) Removes a parameter from the list of parameters to pass to the XSL stylesheet during transformation. |
| jsx3.xml.Cacheable | Removes all parameters from the list of parameters to pass to the XSL stylesheet during transformation. |
| void | resetCacheData(objServer : jsx3.app.Server) Removes the XML and XSL source documents from the server cache. |
| void | Deprecated. renamed to clearXmlData() |
| void | resetXmlCacheData(objServer : jsx3.app.Server) Removes the XML source document stored under the XML ID of this object from the server cache. |
| void | resetXslCacheData(objServer : jsx3.app.Server) Deprecated. Per-instance control of the XSL template is deprecated. Consider using the XML transformers
functionality instead. |
| void | setNodeSet(objNodeSet : jsx3.xml.Entity) Deprecated. |
| jsx3.xml.Cacheable | setShareResources(intShare : int) Sets whether this object removes its XML and XSL source documents from the cache of its server when it
is destroyed. |
| jsx3.xml.Document | Sets the source document of this object as though objDoc were retrieved from the XML URL or XML
string of this object. |
| jsx3.xml.Cacheable | Sets the XML ID of this object. |
| jsx3.xml.Cacheable | setXMLString(strXML : String) Sets the XML string of this object. |
| void | setXMLTransformers(arrTrans : Array<String>) Sets the list of XML transformers of this object. |
| jsx3.xml.Cacheable | Sets the XML URL of this object. |
| jsx3.xml.Cacheable | Deprecated. Per-instance control of the XSL template is deprecated. Consider using the XML transformers
functionality instead. |
| jsx3.xml.Cacheable | Adds a name/value pair to the list of parameters to pass to the XSL stylesheet during transformation. |
| jsx3.xml.Cacheable | setXSLString(strXSL : String) Deprecated. Per-instance control of the XSL template is deprecated. Consider using the XML transformers
functionality instead. |
| jsx3.xml.Cacheable | Deprecated. Per-instance control of the XSL template is deprecated. Consider using the XML transformers
functionality instead. |
| jsx3.xml.Cacheable | setXmlAsync(bAsync : boolean) Sets whether the XML data source of this object is loaded asynchronously. |
| jsx3.xml.Cacheable | setXmlBind(bBind : ?) Sets whether this object is bound to the XML document stored in the data cache. |
| Field Detail |
|---|
shareResources property for an object that removes its XML and XSL
documents from the server XML cache when it is destroyed.shareResources property for an object that leaves its XML and XSL
documents in the server XML cache when it is destroyed.| Method Detail |
|---|
CLEANUPRESOURCES or SHARERESOURCES.
setSourceXML is called on this object, passing in the created document.null, a new document is created by parsing this string.null, a new document is created by parsing the file at the location
specified by the URL resolved against the server owning this object.Cacheable.DEFAULTSTYLESHEET) is returned.0 or 1. 0 or 1. xmlAsync property of this object is true, its datasource is specified as an
XML URL, and the first time doTransform() was called the datasource was still loading.xmlBind property of this object is true.jsxsupermix().this.getServer() does not returns a server instance.
this.getServer() does not returns a server instance.
this.getServer() does not returns a server instance.getXML() as
the XML document to transform.CLEANUPRESOURCES or SHARERESOURCES. CLEANUPRESOURCES
is the default value if the property is null.objDoc were retrieved from the XML URL or XML
string of this object. This method executes the following steps:
jsx3.xml.CDF and the root node is a <data> element
and its jsxassignids attribute is equal to 1, all <record> elements without a
jsxid attribute are assigned a unique jsxid.jsx3.xml.CDF, convertProperties() is called
on this object.objDoc parameter. null or a well-formed serialized XML element.null or a URI that when resolved against the server owning this object
specifies a valid XML document.strValue is null the parameter is removed.onXmlBinding() method of this object is called any time the document stored in
the cache under the XML Id of this object changes.selectSingleNode, selectNodes,
getChildNodes, etc.), the node context will always be the root node (documentElement) and
not the parser instance (ownerDocument). Therefore, all queries are assumed to begin at the root, meaning
querying an instance of this class for the root node (assuming its name is "Price") would require a query such
as "." or "/Price", not "Price".
Note that several methods of this class fail quietly when an error occurs with the wrapped native browser XML
classes. Methods that are documented as failing quietly should always be followed by a call to
hasError() to ensure that no error has occurred.| Field Summary | |
|---|---|
| static String | Event type published when an error occurs during the asynchronous loading of a document. |
| static String | Event type published when an asynchronous load operation has completed successfully. |
| static String | Event type published when an asynchronous load times out before loading. |
| static String | Namespace to use when querying against the namespace axis in firefox |
| static String | Prefix to use when querying against the namespace axis in firefox |
| Constructor Summary | |
|---|---|
| void | init(objDoc : Object | jsx3.xml.Entity) The instance initializer. |
| Method Summary | |
|---|---|
| jsx3.xml.Document | Creates a new node that is an exact clone of this node; returns the newly cloned node wrapped in a jsx3.xml.Entity instance |
| jsx3.xml.Entity | Creates a new root node on an empty document. |
| String | The Firefox implementation of the XSLT specification does not implement a searchable namespace axis. |
| void | Creates a processing instruction node that containing the target and data information. |
| boolean | getAsync(strName : ?) Returns whether this document loads asynchronously. |
| Object | getDeclaredNamespaces(objMap : Object) Returns a map of all implemented namespaces in the following format: {some_uri:"jsx1",some_other_uri,"jsx2",another_uri:"jsx3"}. |
| Object | Returns the native XML parser |
| boolean | Deprecated. IE-only.
|
| String | Deprecated. This method is only implemented on Internet Explorer. XPath is the only supported value.
|
| String | getSelectionNamespaces(strName : ?) Gets a list of namespace prefixes and their associated URIs. |
| String | |
| boolean | Deprecated. IE-only.
|
| static String | Deprecated. |
| String | |
| boolean | |
| String | |
| jsx3.xml.Document | Loads an XML document at the URL specified by the strURL parameter. |
| jsx3.xml.Document | Loads an XML document from a string containing the XML source. |
| void | |
| jsx3.xml.Document | Sets whether this document loads asynchronously. |
| void | setResolveExternals(bResolve : boolean) Deprecated. IE-only.
|
| jsx3.xml.Document | setSelectionLanguage(strLanguage : String) Deprecated. This method is only implemented on Internet Explorer. XPath is the only supported value.
|
| jsx3.xml.Document | setSelectionNamespaces(declaration : Object | String) Sets a list of namespace prefixes and their associated URIs. |
| void | setValidateOnParse(bValidate : boolean) Deprecated. IE-only.
|
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
Entity then clone the node as a new document.
Otherwise, the native browser document object (optional).
| Method Detail |
|---|
Usage:
var objDoc = new jsx3.xml.Document();
objDoc.createDocumentElement("myRoot");
getDeclaredNamespaces
is useful to resolve the prefix actually used, providing a reverse-lookup to resolve the actual prefix being used.
For example, assume objMap is the return object when calling getDeclaredNamespaces. In such a case, the following
query can be used to locate the URI for a given namespace prefix, even though Firefox does not support such a construct:
var objMap = someDoc.getDeclaredNamespaces(); var myXpathQuery = "ancestor-or-self::*[attribute::" + objMap[jsx3.xml.Document.SEARCHABLE_NAMESPACE] + ":xsd]/attribute::" + objMap[jsx3.xml.Document.SEARCHABLE_NAMESPACE] + ":xsd"; var objNode = someNode.selectSingleNode(myXpathQuery,objMap);
xmlns:jsx_xmlns="?"), the prefix will be
incremented as follows: jsx_xmlns0, jsx_xmlns1, jsx_xmlns2, etc, until a unique prefix is found. Usage:
[document].createProcessingInstruction("xml","version=\"1.0\" encoding=\"UTF-8\"");
[document].createDocumentElement("myRoot");
//open an XML Document (just use one of the sample prototypes that ships with Builder)
var objXML = new jsx3.xml.Document();
objXML.load("GI_Builder/prototypes/Block/Text.xml");
//get an object map of all known selection namespaces
var objMap = objXML.getDeclaredNamespaces();
//construct a qualified query (Note that all nodes in a GI serialization file belong to the namespace, 'urn:tibco.com/v3.0')
var myQualifiedQuery = "//" + objMap["urn:tibco.com/v3.0"] + ":object";
//query the document for the given node.
var objNode = objXML.selectSingleNode(myQualifiedQuery,objMap);
//alert the return
alert(objNode);
{prefix1:1,prefix2:1}. If passed, the returned Object will resolve to any matched prefix, while using arbitrary sequential prefixes (jsx1, jsx2, etc) for all other uris.XPath is the only supported value.
strURL parameter. If an error occurs while
loading the XML document, this method sets the error property of this document and returns quietly. If this
document loads synchronously, the results of the load will be available immediately after the call to this
method. Otherwise, this document publishes events through the EventDispatcher interface to notify
the client that loading has completed.null value will cause this operation
to wait forever.async
property of this document.strXML. If, for example, strXML is in unicode format, explicitly passing the UTF-8
encoding attribute will cause the load to fail, as the byte order will cause the parser to look for the
UTF-16 attribute.ON_RESPONSE, ON_ERROR, and
ON_TIMEOUT to notify the client that loading has finished.true the document loads asynchronously.XPath is the only supported value.
XSLPattern, XPath{some_uri:"jsx1",some_other_uri,"jsx2"}
or in String format. For example: "xmlns:jsx1='some_uri' xmlns:jsx2='some_other_uri'"| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Methods Inherited From jsx3.xml.CDF |
|---|
| adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, redrawRecord, reloadFromSource, resetData |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
jsx3.xml.Document class.
Note that several methods of this class fail quietly when an error occurs with the wrapped native browser XML
classes. Methods that are documented as failing quietly should always be followed by a call to
hasError() to ensure that no error has occurred.
| Field Summary | |
|---|---|
| static int | The node type for an attribute node. |
| static int | The node type for a character data node. |
| static int | The node type for a comment node. |
| static int | The node type for an element node. |
| static int | The node type for a text node. |
| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| jsx3.xml.Entity | appendChild(objEntity : jsx3.xml.Entity) Appends the objEntity parameter as a child of this entity. |
| jsx3.xml.Entity | Creates a new node that is an exact clone of this node. |
| jsx3.xml.Entity | Creates a new node and returns as jsx3.xml.Entity instance |
| boolean | equals(objEntity : jsx3.xml.Entity) Tests the equivalency of two jsx3.xml.Entity instances as they wrap and can therefore point to the same native entity, causing a standard "==" comparison to fail |
| String | getAttribute(strName : String) Returns the value for the named attribute strName. |
| Array<String> | Returns the names of all the attributes of this node. |
| jsx3.xml.Entity | getAttributeNode(strName : String) Returns an object reference (a jsx3.xml.Entity instance) to the child attribute with the name, @strName. |
| jsx3.util.List<jsx3.xml.Entity> | Returns handle to a jsx3.util.List instance of all children; note that this collection will always be empty (length = 0) for all types except for jsx3.xml.Entity.TYPEELEMENT |
| String | Returns the right-hand side of a namespace qualified name. |
| jsx3.util.Iterator<jsx3.xml.Entity> | getChildIterator(bIncludeText : boolean) Returns an iterator that iterates over the child nodes of this node. |
| jsx3.util.List<jsx3.xml.Entity> | getChildNodes(bIncludeText : boolean) Returns the child nodes of this entity. |
| Object | getError() Returns an error object (a plain JavaScript object) with two properties that the developer can query for:
code – an integer error code, 0 for no error. |
| jsx3.xml.Entity | Returns the first child element of type jsx3.xml.Entity.TYPEELEMENT; requires that this object also be of TYPEELEMENT; returns null if both conditions are not met |
| jsx3.xml.Entity | Returns the last child element of type jsx3.xml.Entity.TYPEELEMENT; requires that this object also be of TYPEELEMENT; returns null if both conditions are not met |
| String | Returns the value (as string) for URI (universal resource identifier) of the namespace for the given node; returns an empty string if no namespace exists |
| Object | Returns the native browser XML node wrapped by this entity. |
| jsx3.xml.Entity | Returns the next sibling if this node and the referenced sibling are of type jsx3.xml.Entity.TYPEELEMENT; returns null if condition is not met |
| String | Returns the name of the node as string (assuming this jsx3.xml.Entity instance is of type jsx3.xml.Entity.TYPEELEMENT or jsx3.xml.Entity.TYPEATTRIBUTE). |
| int | Returns one of: jsx3.xml.Entity.TYPEELEMENT, jsx3.xml.Entity.TYPEATTRIBUTE, jsx3.xml.Entity.TYPETEXT, jsx3.xml.Entity.TYPECDATA |
| jsx3.xml.Document | Returns the document that owns this entity. |
| jsx3.xml.Entity | Returns the parent node of the context node. |
| String | Returns the left-hand side of a namespace qualified name. |
| jsx3.xml.Entity | Returns the previous sibling if this node and the referenced sibling are of type jsx3.xml.Entity.TYPEELEMENT; returns null if condition is not met |
| jsx3.xml.Entity | Returns reference to the document element (root) wrapped in jsx3.xml.Entity instance |
| String | getValue() Contains the text content of the node, including the concatenated text contained by all descendant entities |
| static String | Deprecated. |
| String | getXML() Deprecated. Use toString() instead. |
| boolean | hasError() Returns true if the last operation on this XML entity caused an error. |
| jsx3.xml.Entity | inserts the jsx3.xml.Entity instance, @objEntityNew immediately before the existing child @objEntityRef and returns a handle to @objEntityNew; requires that both parameters be of type jsx3.xml.Entity.TYPEELEMENT; requires that this object also be of TYPEELEMENT; returns null if all conditions are not met |
| void | removeAttribute(strAttName : String) Removes the specified attribute by the given name (can only be called for nodes of type jsx3.xml.Entity.TYPELEMENT) |
| jsx3.xml.Entity | removeAttributeNode(objAtt : jsx3.xml.Entity) removes the attribute object as a child of the element; |
| jsx3.xml.Entity | removeChild(objChildEntity : jsx3.xml.Entity) Removes the specified child (@objChildEntity) from the list of children and returns it; returns null if @objChildEntity is not actually a child |
| void | Removes all descendant entities of this node
|
| jsx3.xml.Entity | replaces the child @objEntityOld with @objEntityNew and returns a handle to @objEntityOld; requires that both child entities be of type jsx3.xml.Entity.TYPEELEMENT; requires that this object also be of TYPEELEMENT; returns null if all conditions are not met |
| jsx3.util.Iterator<jsx3.xml.Entity> | Returns an iterator that iterates over the the result of an XPath query. |
| jsx3.util.List<jsx3.xml.Entity> | Returns a list of nodes selected by an XPath query executed on this node. |
| jsx3.xml.Entity | Returns a single node selected by an XPath query executed on this node, or null if none is selected. |
| jsx3.xml.Entity | Sets the @strValue of the named @strAttribute and binds as child of this |
| jsx3.xml.Entity | setAttributeNode(objAtt : jsx3.xml.Entity) Sets the attribute object as a child of the element; if transferring an attribute from one element to another, this call must be preceded with removeAttributeNode on the previous owner |
| jsx3.xml.Entity | sets the text value for this entity; returns a handle to this jsx3.xml.Entity instance |
| String | toString() Returns the XML (as String) for this node and any descendants. |
| String | jsx3.xml.Document | transformNode(objEntityFilter : jsx3.xml.Entity, objParams : Object<String, String>, bObject : boolean) performs an XSLT transformation, using @objEntityFilter as the XSLT filter for the transformation; returns
results of the transformation as a string (of text/html/xml/etc) |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
objEntity parameter as a child of this entity. If an error occurs while
appending to this XML entity, this method sets the error property of this entity and returns quietly.strName.null if the attribute does not exist.
getAttributes() method.TYPEELEMENT.next() is called, the value returned by the previous call to
next() is no longer valid. This method is more performant than getChildNodes().
Note also that the iterator is a pointer into the children node list so removing or adding children to this node
while iterating may cause unexpected behavior.true then the returned iterator will include the child text nodes
of this node.bIncludeText is true.true, text and cdata children are returned with element children.toString() instead.true if the last operation on this XML entity caused an error.next() is called, the value returned by the previous call to
next() is no longer valid. This method is more performant than selectNodes().//somenode[@id='12']/somechild.setSelectionNamespaces() on the owning document. The format of this parameter
as a string is "xmlns:ns1='uri1' xmlns:ns2='uri2'" or as an object is {'uri1':'ns1',
'uri2':'ns2'}.//somenode[@id='12']/somechild.setSelectionNamespaces() on the owning document. The format of this parameter
as a string is "xmlns:ns1='uri1' xmlns:ns2='uri2'" or as an object is {'uri1':'ns1',
'uri2':'ns2'}.null if none is selected.
Note that the XPath query is executed in the context of this node so relative paths are relative to this node.
However, this node may be nested in a larger XML document, in which case absolute paths are relative to the
root document of this node. This behavior matches the XPath specification.//somenode[@id='12']/somechild.setSelectionNamespaces() on the owning document. The format of this parameter
as a string is "xmlns:ns1='uri1' xmlns:ns2='uri2'" or as an object is {'uri1':'ns1',
'uri2':'ns2'}.true this method returns a document instead of a string.jsx3.xml.Template instead.| Constructor Summary | |
|---|---|
| void | The instance initializer. |
| Method Summary | |
|---|---|
| Object | getError() Returns an error object (a plain JavaScript object) with two properties that the developer can query for:
code – an integer error code, 0 for no error. |
| boolean | hasError() Returns true if the last operation on this XML entity caused an error. |
| jsx3.xml.Processor | Sets reference to Params that should be passed to the processor. |
| Object | setXML(objXML : jsx3.xml.Entity) Sets the XML that should be transformed. |
| jsx3.xml.Processor | setXSL(objXSL : jsx3.xml.Document) Sets reference to XSL that should be transformed. |
| String | Performs an XSLT merge. |
| jsx3.xml.Document | Performs an XSLT merge. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
true if the last operation on this XML entity caused an error.null.null.| Constructor Summary | |
|---|---|
| void | init(objXSL : jsx3.xml.Document) The instance initializer. |
| Method Summary | |
|---|---|
| Object | getError() Returns an error object (a plain JavaScript object) with two properties that the developer can query for:
code – an integer error code, 0 for no error. |
| boolean | hasError() Returns true if the last operation on this XML entity caused an error. |
| void | reset() |
| void | |
| void | |
| String | Performs an XSLT merge. |
| jsx3.xml.Document | transformToObject(objXML : jsx3.xml.Entity) Performs an XSLT merge. |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString |
| Constructor Detail |
|---|
objXSL is not a valid XML document.
| Method Detail |
|---|
true if the last operation on this XML entity caused an error.null.null.jsx3.xml.Document that encapsulates a compiled XSL template.
| Method Summary | |
|---|---|
| void | reset() |
| void | |
| void | |
| void | transform(objXML : jsx3.xml.Entity) |
| void | transformToObject(objXML : jsx3.xml.Entity) |
| static jsx3.xml.XslDocument | wrap(objXML : jsx3.xml.Document) |
| Methods Inherited From jsx3.util.EventDispatcher |
|---|
| publish, subscribe, unsubscribe, unsubscribeAll |
| Methods Inherited From jsx3.lang.Object |
|---|
| clone, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf |
| Method Detail |
|---|
window. prefix.| Class Summary | |
|---|---|
| Array | Native JavaScript class Array. |
| Boolean | Native JavaScript class Boolean. |
| Date | Native JavaScript class Date. |
| Function | Native JavaScript class Function. |
| HTMLDocument | Native browser DOM class HTMLDocument. |
| HTMLElement | Native browser DOM class HTMLElement. |
| Math | Native JavaScript class Math. |
| Number | Native JavaScript class Number. |
| Object | Native JavaScript class Object. |
| RegExp | Native JavaScript class RegExp. |
| String | Native JavaScript class String. |
| inheritance | Deprecated. Renamed to jsx3.lang.Object |
| Field Summary | |
|---|---|
| native static void | |
| native static void | |
| native static void | |
| Method Summary | |
|---|---|
| static void | Deprecated. Create classes using jsx3.Class. |
| static void | Deprecated. Create classes using jsx3.Class. |
| static void | Deprecated. Create classes using jsx3.Class. |
| static void | Deprecated. Use jsx3.Class.mixin(). |
| native static void | escape() |
| native static void | eval() |
| native static void | isFinite() |
| native static void | isNaN() |
| native static void | |
| native static void | parseInt() |
| native static void | unescape() |
| Field Detail |
|---|
| Method Detail |
|---|
jsx3.Class.jsx3.Class.jsx3.Class.jsx3.Class.mixin().| Field Summary | |
|---|---|
| native int | An unsigned, 32-bit integer that specifies the number of elements in an array. |
| Constructor Summary | |
|---|---|
| native void | Array() |
| Method Summary | |
|---|---|
| Array | clone() Deprecated. Use the jsx3.util.List class.
|
| native Array | Joins two or more arrays and returns a new array. |
| void | contains(objElement : ?) Deprecated. Use the jsx3.util.List class.
|
| boolean | contentsEqual(a : Array) Deprecated. Use the jsx3.util.List class.
|
| Array | Deprecated. Use the jsx3.util.List class.
|
| int | Deprecated. Use the jsx3.util.List class.
|
| native String | Joins all elements of an array into a string. |
| int | Deprecated. Use the jsx3.util.List class.
|
| Array | Object | Deprecated. Use the jsx3.util.List class.
|
| native Object | pop() Removes the last element from an array and returns that element. |
| native int | Adds one or more elements to the end of an array and returns the new length of the array. |
| void | Deprecated. Use the jsx3.util.List class.
|
| void | remove(objElement : ?) Deprecated. Use the jsx3.util.List class.
|
| native void | reverse() Transposes the elements of an array: the first array element becomes the last and the last becomes the first. |
| native Object | shift() Removes the first element from an array and returns that element. |
| native Array | Extracts a section of an array and returns a new array. |
| native void | Sorts the elements of an array. |
| native Array | Changes the content of an array, adding new elements while removing old elements. |
| native String | toString() Returns a string representing the specified array and its elements. |
| native int | Adds one or more elements to the beginning of an array and returns the new length of the array. |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.util.List class.
jsx3.util.List class.
jsx3.util.List class.
a have the same length and this[n] = a[n] for all n.jsx3.util.List class.
fctFilter parameter defines
the filtering function.function(item : Object) : boolean.jsx3.util.List class.
objElement in this array.jsx3.util.List class.
objElement in this array.jsx3.util.List class.
fctMapper parameter defines
the mapping function.
This method has four modes corresponding to the four possible values for {bExpand, bObject}:
{false, false} (default) – the filtering function takes an item in this list and returns
a single object value which will take the place of the item in the mapped result.{true, false} – the filtering function takes an item in this list and returns
a single object value or an array of values, all of which will be inserted into the mapped result at the index
of the item.{false, true} – the filtering function takes an item in this list and returns an array with
exactly two values, which become a name/value pair in the mapped result.{true, true} – the filtering function takes an item in this list and returns an array with
zero or an even number of items, which become name/value pairs in the mapped result.bExpand and
bObject parameters.true, the resulting mapped array or object may any number of values
corresponding to each item in this list. Otherwise, it will have exactly one value for each item in this list.true, this array is mapped to an object with property name/value pairs.
Otherwise this array is mapped to another array.Array if the bObject parameter is null or
false, otherwise an Object. jsx3.util.List class.
jsx3.util.List class.
objElement in this array| Constructor Summary | |
|---|---|
| native void | Date() |
| Method Summary | |
|---|---|
| int | Deprecated. |
| void | Deprecated. |
| native void | getDate() |
| native void | getDay() |
| native void | |
| native void | getHours() |
| int | Deprecated. |
| native void | |
| native void | |
| native void | getMonth() |
| native void | |
| native void | getTime() |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | getYear() |
| native static void | parse() |
| native void | setDate() |
| native void | |
| native void | setHours() |
| native void | |
| native void | |
| native void | setMonth() |
| native void | |
| native void | setTime() |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| native void | |
| Methods Inherited From Object |
|---|
| toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
d
| Constructor Summary | |
|---|---|
| native void | Function() |
| Method Summary | |
|---|---|
| native Object | |
| native Object | |
| Methods Inherited From Object |
|---|
| toString |
| Constructor Detail |
|---|
| Method Detail |
|---|
HTMLDocument. Mozilla browsers call this HTMLDocument, while
Microsoft Internet Explorer usually reports it as a plain Object.| Fields Inherited From HTMLElement |
|---|
| childNodes, className, firstChild, id, innerHTML, lastChild, nextSibling, ownerDocument, parentNode, previousSibling, style, tagName |
| Method Summary | |
|---|---|
| native HTMLElement | getElementById(strId : String) |
| Methods Inherited From HTMLElement |
|---|
| getAttribute, removeAttribute, setAttribute |
| Methods Inherited From Object |
|---|
| toString |
| Method Detail |
|---|
HTMLElement. Mozilla browsers call this HTMLElement, while
Microsoft Internet Explorer usually reports it as a plain Object.| Field Summary | |
|---|---|
| native Array<HTMLElement> | |
| native String | |
| native HTMLElement | |
| native String | |
| native String | |
| native HTMLElement | |
| native HTMLElement | |
| native HTMLDocument | |
| native HTMLElement | |
| native HTMLElement | |
| native Object | |
| native String | |
| Method Summary | |
|---|---|
| native String | getAttribute(strName : String) |
| native void | removeAttribute(strName : String) |
| native void | |
| Methods Inherited From Object |
|---|
| toString |
| Field Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| native static Number | |
| native static Number | |
| native static Number | |
| native static Number | |
| native static Number | |
| native static Number | |
| native static Number | |
| native static Number | |
| Method Summary | |
|---|---|
| native static void | abs() |
| native static void | acos() |
| native static void | asin() |
| native static void | atan() |
| native static void | atan2() |
| native static void | ceil() |
| native static void | cos() |
| native static void | exp() |
| native static void | floor() |
| static boolean | Deprecated. Use jsx3.util.numIsNaN() instead.
|
| native static void | log() |
| native static void | max() |
| native static void | min() |
| static Number | Deprecated. Use jsx3.util.numMod() instead.
|
| native static void | pow() |
| native static void | random() |
| native static void | round() |
| native static void | sin() |
| native static void | sqrt() |
| native static void | tan() |
| Methods Inherited From Object |
|---|
| toString |
| Field Detail |
|---|
| Method Detail |
|---|
jsx3.util.numIsNaN() instead.
jsx3.util.numMod() instead.
| Field Summary | |
|---|---|
| native static Number | |
| native static Number | |
| native static Number | |
| native static Number | |
| native static Number | |
| Constructor Summary | |
|---|---|
| native void | Number() |
| Method Summary | |
|---|---|
| Number | Deprecated. Use jsx3.util.numRound() instead.
|
| native void | toFixed() |
| native void | |
| String | Deprecated. Use the jsx3.util.NumberFormat class.
|
| Methods Inherited From Object |
|---|
| toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.util.numRound() instead.
jsx3.util.NumberFormat class.
intDigits.| Constructor Summary | |
|---|---|
| native void | Object() |
| Method Summary | |
|---|---|
| native String | toString() |
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| native static String | |
| native boolean | |
| native boolean | |
| native static String | |
| native int | |
| native static String | |
| native static String | |
| native static String | |
| native static boolean | |
| native static String | |
| native String | |
| Constructor Summary | |
|---|---|
| native void | RegExp() |
| Method Summary | |
|---|---|
| native void | compile() |
| native void | exec() |
| native void | test() |
| Methods Inherited From Object |
|---|
| toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
| Field Summary | |
|---|---|
| native void | |
| Constructor Summary | |
|---|---|
| native void | String() |
| Method Summary | |
|---|---|
| native void | charAt() |
| native void | |
| native void | concat() |
| String | Deprecated. Use jsx3.util.strTruncate() instead.
|
| String | Deprecated. Use String.replace() with regular expression syntax.
|
| String | doTruncate(intLength : int) Deprecated. Use jsx3.util.strTruncate() instead.
|
| boolean | Deprecated. Use jsx3.util.strEndsWith() instead.
|
| String | Deprecated. Use jsx3.util.strEscapeHTML() instead.
|
| String | Deprecated. Use jsx3.util.strDecodeBase64() instead.
|
| native static void | |
| native void | indexOf() |
| native void | match() |
| native void | replace() |
| native void | search() |
| native void | slice() |
| native void | split() |
| native void | |
| String | Deprecated. Use jsx3.resolveURI(). |
| String | toBase64() Deprecated. Use jsx3.util.strEncodeBase64() instead.
|
| native void | |
| native void | |
| String | trim() Deprecated. Use jsx3.util.strTrim() instead.
|
| String | Deprecated. Create instances of jsx3.net.URI and use URI.resolve(). |
| Methods Inherited From Object |
|---|
| toString |
| Field Detail |
|---|
| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.util.strTruncate() instead.
String.replace() with regular expression syntax.
jsx3.util.strTruncate() instead.
jsx3.util.strEndsWith() instead.
jsx3.util.strEscapeHTML() instead.
jsx3.util.strDecodeBase64() instead.
jsx3.resolveURI().jsx3.util.strEncodeBase64() instead.
jsx3.util.strTrim() instead.
jsx3.net.URI and use URI.resolve().